TypingMindTypingMindThe best frontend for AI
UCM REST Client logo

UCM REST Client

Organization
oracle
UCM REST Client

Calls Oracle Fusion UCM HTTP IdcService APIs using OAuth, including ping, search, metadata lookup, file check-in, and file download. Use when a workflow needs a UCM dDocName such as UCMFA00000000, needs to stage a local file without ERP SOAP uploadFileToUcm, or needs to inspect/download UCM content used by Import Management or Export Management.

Overview

Publisheroracle
RepositoryFusion-Setup-Configuration-Registry
Skill nameUCM REST Client
Stars
112
Forks
26
Bundled files
3
LicenseUPL-1.0
Links
Skill sourceRepository
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 3 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by oracle on GitHub. Read the source before you install it.

Installation

Install the UCM REST Client AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/oracle/Fusion-Setup-Configuration-Registry/tree/main/core/fusion-api/ucm-rest-client
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/oracle/Fusion-Setup-Configuration-Registry.git /tmp/Fusion-Setup-Configuration-Registry
mkdir -p .claude/skills
cp -r /tmp/Fusion-Setup-Configuration-Registry/core/fusion-api/ucm-rest-client .claude/skills/oracle-ucm-rest-client
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable UCM REST Client in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads UCM REST Client on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so UCM REST Client is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

UCM REST Client

Use this core skill when a workflow needs to interact with Fusion UCM directly through the HTTP IdcService endpoint instead of the ERP Integration Service SOAP wrapper.

Required Reference

Before changing service names, metadata fields, or CX Import hand-off behavior, read:

  • references/oracle-ucm-http-idcservice.md

Boundary

This is not the CX Import Management API. It only stages, locates, inspects, and downloads UCM documents. CX Import Management still consumes the resulting UCM document name through DataFiles[].InputFileContentId.

For CX imports, the important returned value is usually dDocName, for example UCMFA06213998. A numeric dID/document id is useful for UCM metadata lookup but is not the same value as the CX import InputFileContentId.

Some Fusion environments do not accept OAuth bearer tokens directly on /cs/idcplg and return the WebCenter Content sign-in page instead. In that case, use --auth-mode basic --prompt-password with the Fusion username from fusionEnv.properties or --username. If Basic auth also returns the sign-in page, the pod is enforcing an interactive SSO cookie for /cs/idcplg; use the ERP Integration Service SOAP path or another Oracle-supported server-side content upload API for automation.

Commands

Ping the UCM endpoint:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py ping \
  --summary \
  --token-cache auto

Ping with Basic authentication when /cs/idcplg does not accept OAuth bearer tokens:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py ping \
  --auth-mode basic \
  --prompt-password \
  --summary

Upload a CSV to an Import Management document account:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py upload \
  --file project/cx-test/accounts.csv \
  --auth-mode basic \
  --prompt-password \
  --document-account "crm/simplifiedAccount/import/" \
  --security-group FAFusionImportExport \
  --title accounts.csv \
  --execute \
  --summary \
  --token-cache auto

Fetch metadata for the uploaded UCM document:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py info \
  --ddoc-name UCMFA00000001 \
  --summary \
  --token-cache auto

Search for recently staged documents:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py search \
  --query-text "dSecurityGroup <matches> `FAFusionImportExport`" \
  --result-count 10 \
  --summary \
  --token-cache auto

Download the primary file:

bash
python3 core/fusion-api/ucm-rest-client/scripts/ucm_rest_client.py download \
  --ddoc-name UCMFA00000001 \
  --output project/cx-test/downloaded/accounts.csv \
  --token-cache auto

Authenticated requests are restricted to HTTPS hosts configured by restBaseUrl or *_restBaseUrl in core/auth/fusionEnv.properties; other hosts and redirects to them are rejected before Basic or bearer credentials are sent.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the UCM REST Client AI skill do?

Calls Oracle Fusion UCM HTTP IdcService APIs using OAuth, including ping, search, metadata lookup, file check-in, and file download. Use when a workflow needs a UCM dDocName such as UCMFA00000000, needs to stage a local file without ERP SOAP uploadFileToUcm, or needs to inspect/download UCM content used by Import Management or Export Management.

Why use UCM REST Client on TypingMind?

Because you install it once and use it with any model. UCM REST Client is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install UCM REST Client in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/oracle/Fusion-Setup-Configuration-Registry/tree/main/core/fusion-api/ucm-rest-client. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use UCM REST Client?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with UCM REST Client?

As many as you like. As long as a model supports skills, you can use UCM REST Client with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the UCM REST Client AI skill free?

Yes. It is published on GitHub by oracle under the UPL-1.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
affaan-m logo

Django Patterns

affaan-m
CommunityPopular

Patrones de arquitectura Django, diseño de API REST con DRF, buenas prácticas de ORM, caché, señales, middleware y aplicaciones Django de nivel producción.

39.1K
261.1K
Instructions
View
affaan-m logo

Quarkus Patterns

affaan-m
CommunityPopular

Patrones de arquitectura Quarkus 3.x LTS con Camel para mensajería, diseño de API RESTful, servicios CDI, acceso a datos con Panache y procesamiento asíncrono.

39.1K
261.1K
Instructions
View
affaan-m logo

Quarkus Security

affaan-m
CommunityPopular

Buenas prácticas de seguridad en Quarkus para autenticación, autorización, JWT/OIDC, RBAC, validación de entrada, CSRF, gestión de secretos y seguridad de dependencias.

39.1K
261.1K
Instructions
View
affaan-m logo

Quarkus Verification

affaan-m
CommunityPopular

Bucle de verificación para proyectos Quarkus: build, análisis estático, pruebas con cobertura, escaneos de seguridad, compilación nativa y revisión de diff antes del lanzamiento o PR.

39.1K
261.1K
Instructions
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇