Config
Config APIs are used to access, maintain, and updaate the repository configuration files.
GET /api/admin/config
Access a list of all the available repository config files
Params
None
Response
200 - OK on success
Example Response
{ "count": 2, "items": [ { "CACHE_ROOT": "ExampleCompany", "id": "2de58334-5679-4cad-7341-e54e93870b3b", "OCE_BASE_URL": "https://ocegen2-example.cec.ocp.oraclecloud.com", "AZURE_BASE_URL": "", "AUTH_TYPE": "Azure", "IDCS_URL": "https://idcs-57bc9b02b7489c38a7389014dc7edbe1c.identity.oraclecloud.com", "CLIENT_ID": "88d7c1cbddbc989756d234a153e5f948ca", "CLIENT_SECRET": "cf233m756-2789-4512-a42e-a08c31e7ac5e", "AUTH_SCOPE": "https://1ABA33B6ED758998HGJR2FB081CF85B2.cec.ocp.oraclecloud.com:443/urn:opc:cec:all", "OCE_TYPES": "WebContentList,WebsiteConfig,WebImage,Footer-Link-List-Group,HeaderContent,Tile-Gallery,Link,Events-Content,Event,FooterContent,ListWebContentLists,WebContent,HeaderList,LinkList,Tile-Content,Vector,BrightcoveVideo,File,Image", "GENERATE_EMBEDDINGS": false, "OCE_TAXONOMIES": "TEST TAXONOMY", "OCE_TYPES_EXTRACTREFS_FIELDS": {}, "OCE_PUBLISH_CHANNEL": "fa9ad92d748hjj79j77cfab51371c4f0", "OCE_PUBLISH_CHANNEL_ID": "CHANNELF8A254C6F1F23639CB8D8C78665488DAF9EA4CACC52E", "OCE_ADMINS": "user1@example.com,user2@example.com", "OCE_UPLOAD_FOLDER": "", "ENABLE_GRAPHQL": true, "OCE_REPO_ID": "051B15F81F9CHF7659DDFB4E7B6AD3F2", "CACHE_INDEX_FIELDS": [ { "name": "body" }, { "name": "title", "weight": "10" } ], "CUSTOM_FIELDS": {}, "REFERENCE_FIELDS_OVERRIDE_SINGLE_TO_MULTIPLE": {}, "SYNONYMS": {}, "TYPES": "WebContentList,WebsiteConfig,WebImage,FooterLinkListGroup,HeaderContent,TileGallery,Link,EventsContent,Event,FooterContent,ListWebContentLists,WebContent,HeaderList,LinkList,TileContent,Vector,BrightcoveVideo,File,Image,Upload,Folder", "SECURITY": { "maintainers": [ "admin" ], "contributors": [], "viewers": [] }, "TAXONOMIES": "test tax 1" }, { "CACHE_ROOT": "Test1", "id": "c4069b84-5j8d-451a-2346-c72c942c8b09", "TYPES": "File,Image,Upload,Video,Folder", "SECURITY": { "contributors": [], "maintainers": [ "admin" ], "viewers": [] }, "OCE_BASE_URL": "", "AZURE_BASE_URL": "", "IDCS_URL": "", "AUTH_SCOPE": "", "OCE_TYPES": "", "OCE_TAXONOMIES": "", "OCE_PUBLISH_CHANNEL": "", "OCE_PUBLISH_CHANNEL_ID": "", "OCE_ADMINS": "", "OCE_UPLOAD_FOLDER": "", "OCE_REPO_ID": "", "ENABLE_GRAPHQL": true, "GENERATE_EMBEDDINGS": false, "OCE_COPY_DIGITAL_ASSETS": true, "GENERATE_EMBEDDINGS_AI_MODEL": true, "CACHE_INDEX_FIELDS": [], "ai": { "default_settings": { "CONTEXT_DOCUMENT_NUMBER": "", "RELEVANT_DOCUMENT_RETURN_FIELDS": [], "HISTORY_RECENT_NUMBER": "", "HISTORY_RELEVANT_NUMBER": "", "EMBED_CHUNK_SIZE": "", "EMBED_CHUNK_OVERLAP": "" } }, "CUSTOM_FIELDS": {}, "REFERENCE_FIELDS_OVERRIDE_SINGLE_TO_MULTIPLE": {}, "SYNONYMS": {}, "TAXONOMIES": "Enovis DJO,test tax 1" }, { "CACHE_ROOT": "azure12", "id": "1a7241f3-f82b-1238-a34e-2ff71431b4ef", "TYPES": "File,Image,Upload,Video,Folder", "SECURITY": { "contributors": [], "maintainers": [ "admin" ], "viewers": [] }, "OCE_BASE_URL": "", "AZURE_BASE_URL": "", "IDCS_URL": "", "AUTH_SCOPE": "", "OCE_TYPES": "", "OCE_TAXONOMIES": "", "OCE_PUBLISH_CHANNEL": "", "OCE_PUBLISH_CHANNEL_ID": "", "OCE_ADMINS": "", "OCE_UPLOAD_FOLDER": "", "OCE_REPO_ID": "", "ENABLE_GRAPHQL": true, "GENERATE_EMBEDDINGS": false, "OCE_COPY_DIGITAL_ASSETS": true, "GENERATE_EMBEDDINGS_AI_MODEL": true, "CACHE_INDEX_FIELDS": [], "ai": { "default_settings": { "CONTEXT_DOCUMENT_NUMBER": "", "RELEVANT_DOCUMENT_RETURN_FIELDS": [], "HISTORY_RECENT_NUMBER": "", "HISTORY_RELEVANT_NUMBER": "", "EMBED_CHUNK_SIZE": "", "EMBED_CHUNK_OVERLAP": "" } }, "CUSTOM_FIELDS": {}, "REFERENCE_FIELDS_OVERRIDE_SINGLE_TO_MULTIPLE": {}, "SYNONYMS": {}, "storage": { "bucketName": "fbcms-1a7241f3-f82b-4173-a34e-2ff71431b4ef-azure12" } }, ]}GET /api/admin/config/:id
Retrieves the config file for the specified repository based on it’s ID
Params
id - The repository ID
Response
200 - OK on success
Example Response
{ "id": "c4069b84-4f1b-451a-9988-c72c942c8b09", "CACHE_ROOT": "Test1", "TYPES": "File,Image,Upload,Video,Folder", "SECURITY": { "contributors": [], "maintainers": [ "admin" ], "viewers": [] }, "OCE_BASE_URL": "", "AZURE_BASE_URL": "", "IDCS_URL": "", "AUTH_SCOPE": "", "OCE_TYPES": "", "OCE_TAXONOMIES": "", "OCE_PUBLISH_CHANNEL": "", "OCE_PUBLISH_CHANNEL_ID": "", "OCE_ADMINS": "", "OCE_UPLOAD_FOLDER": "", "OCE_REPO_ID": "", "ENABLE_GRAPHQL": true, "GENERATE_EMBEDDINGS": false, "OCE_COPY_DIGITAL_ASSETS": true, "GENERATE_EMBEDDINGS_AI_MODEL": true, "CACHE_INDEX_FIELDS": [], "ai": { "default_settings": { "CONTEXT_DOCUMENT_NUMBER": "", "RELEVANT_DOCUMENT_RETURN_FIELDS": [], "HISTORY_RECENT_NUMBER": "", "HISTORY_RELEVANT_NUMBER": "", "EMBED_CHUNK_SIZE": "", "EMBED_CHUNK_OVERLAP": "" } }, "CUSTOM_FIELDS": {}, "REFERENCE_FIELDS_OVERRIDE_SINGLE_TO_MULTIPLE": {}, "SYNONYMS": {}, "TAXONOMIES": "test tax 1"}POST /api/admin/config
Creates a new config file for a new repository
Params
None
Response
200 - OK on success
Example Response
{ "id": "a2405bdb-726a-49e8-89f5-ffebd61516f3"}DELETE /api/admin/config/:config_id
Delete the specified config based on the given config ID
Params
config-id = ID of the repository you wish to delete
Resonse
200 - OK on success
Example Response
1