Conga Rules API
The Rules API from Conga — 10 operation(s) for rules.
Operations 12
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which approval rules exist for a business object, by name?”
“Can I filter approval rules to just the active ones and sort them?”
Tell an agent
Search approval rules on {businessObjectName}.
Find rules on {businessObjectName} matching {filter}.
Ask an LLM
“How do I create an approval rule with its rule entries?”
“Can I write a rule definition with several entries at once?”
Tell an agent
Save an approval rule with these entries: {RuleEntries}.
Create a new approval rule from the entries I describe.
Ask an LLM
“Is this rule name already taken for the object type?”
“Can I validate a rule name before I save the rule?”
Tell an agent
Check whether rule name {ruleName} exists for {businessObjectType}.
Validate rule name {ruleName} on {businessObjectType} objects.
Ask an LLM
“Can I permanently remove an approval rule?”
“What call deletes a whole rule rather than one entry?”
Tell an agent destructive · confirm first
Delete approval rule {id}.
Remove the entire rule {id}.
Ask an LLM
“What does one approval rule contain?”
“Can I fetch a rule and its entries by ID?”
Tell an agent
Show me approval rule {id}.
Fetch the definition of rule {id}.
Ask an LLM
“How do I turn an approval rule on?”
“Can I reactivate a rule I switched off earlier?”
Tell an agent
Activate approval rule {id}.
Turn on rule {id}.
Ask an LLM
“Can I duplicate a rule to use as a template?”
“Is there a way to copy an existing approval rule?”
Tell an agent
Clone approval rule {id}.
Make a copy of rule {id}.
Ask an LLM
“Can I switch off a whole rule without deleting it?”
“What disables an approval rule temporarily?”
Tell an agent
Deactivate approval rule {id}.
Turn off rule {id} but keep it.
DELETE
/v1/rules/{id}/rule-entries/{ruleEntryId}
Delete an entry from an approval rule · Delete an approval rule entry
#
Ask an LLM
“Can I remove just one entry from a rule?”
“What happens if I delete a single rule entry?”
Tell an agent destructive · confirm first
Delete entry {ruleEntryId} from rule {id}.
Remove rule entry {ruleEntryId} in rule {id}.
POST
/v1/rules/{id}/rule-entries/{ruleEntryId}/activate
Activate an approval rule entry · Activate an approval rule entry
#
Ask an LLM
“Can I turn on one entry inside a rule?”
“Which call re-enables a single rule entry?”
Tell an agent
Activate entry {ruleEntryId} in rule {id}.
Switch on rule entry {ruleEntryId} of rule {id}.
POST
/v1/rules/{id}/rule-entries/{ruleEntryId}/deactivate
Deactivate an approval rule entry · Deactivate an approval rule entry
#
Ask an LLM
“Can I disable one rule entry while leaving the rule active?”
“Is it possible to switch off a single entry in a rule?”
Tell an agent
Deactivate entry {ruleEntryId} in rule {id}.
Switch off rule entry {ruleEntryId} of rule {id}.
GET
/v1/rules/{id}/sequence/{ruleSequenceId}/unreferenced-steps
List rule entries available as dependencies · Get rule entry dependencies
#
Ask an LLM
“Which rule entries could the current entry depend on?”
“What entries in a rule sequence are free to use as dependencies?”
Tell an agent
List entries available as dependencies for sequence {ruleSequenceId} in rule {id}.
Show possible dependency entries for rule {id}, sequence {ruleSequenceId}.
Documentation
Authentication
https://artifacts.apis.io/conga/authentication/conga-authentication.yml
RateLimits
https://artifacts.apis.io/conga/rate-limits/conga-rate-limits.yml
Specifications
Other Resources
DataModel
https://artifacts.apis.io/conga/data-model/conga-data-model.yml
OAuthScopes
https://artifacts.apis.io/conga/scopes/conga-scopes.yml
Conventions
https://artifacts.apis.io/conga/conventions/conga-conventions.yml
ErrorCatalog
https://artifacts.apis.io/conga/errors/conga-problem-types.yml
Lifecycle
https://artifacts.apis.io/conga/lifecycle/conga-lifecycle.yml
Conformance
https://artifacts.apis.io/conga/conformance/conga-conformance.yml
Sandbox
https://artifacts.apis.io/conga/sandbox/conga-sandbox.yml
Webhooks
https://artifacts.apis.io/conga/asyncapi/conga-webhooks.yml