Conga

Conga Rules API

The Rules API from Conga — 10 operation(s) for rules.

GitHub OpenAPI

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

GET /v1/rules Search approval rules for a business object · Search rules #
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}.
POST /v1/rules Save an approval rule · Save an approval rule #
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.
GET /v1/rules/validate Check whether a rule name is already used · Validate a rule name #
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.
DELETE /v1/rules/{id} Delete an approval rule · Delete an approval rule #
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}.
GET /v1/rules/{id} Get an approval rule by ID · Get an approval rule #
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}.
POST /v1/rules/{id}/activate Activate an approval rule · Activate an approval rule #
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}.
POST /v1/rules/{id}/clone Copy an approval rule · Clone an approval rule #
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}.
POST /v1/rules/{id}/deactivate Deactivate an approval rule · Deactivate an approval rule #
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://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-rules-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Approvals Rules API
  description: The Approvals API is used to submit, preview, and retrieve approval processes.
  version: v1
servers:
- url: https://rls.congacloud.com/api/approvals
security: []
tags:
- name: Rules
paths:
  /v1/rules:
    get:
      tags:
      - Rules
      summary: Search rules
      description: Searches rules by name using a filter string.
      operationId: Rules_GetAll
      parameters:
      - name: businessObjectName
        in: query
        required: true
        description: The business object name
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: filter
        in: query
        description: 'The filter string (example: IsActive = ''true'')'
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: page
        in: query
        description: 'The page number (default: 1)'
        schema:
          type: integer
          format: int32
          default: 1
        x-position: 3
      - name: limit
        in: query
        description: The maximum number of items to be returned
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 4
      - name: sort_by_field
        in: query
        description: The field to sort by
        schema:
          type: string
          default: ModifiedDate
        x-position: 5
      - name: sort_direction
        in: query
        description: The direction to sort based on the field
        schema:
          default: DESC
          oneOf:
          - $ref: '#/components/schemas/SortDirection'
        x-position: 6
      - name: active
        in: query
        description: Active rules
        schema:
          type:
          - boolean
          - 'null'
        x-position: 7
      responses:
        '200':
          description: List of ApprovalRule with the search string in their name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalsAPIResponseOfListOfApprovalRule'
      security:
      - oauth2: []
      - Bearer: []
    post:
      tags:
      - Rules
      summary: Save an approval rule
      description: Writes an approval rule definition.
      operationId: Rules_Save
      requestBody:
        x-name: requestRulePayload
        description: The ApprovalRule to be saved
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalRuleDTO'
        required: true
        x-position: 1
      responses:
        '200':
          description: The ApprovalRuleDTO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/validate:
    get:
      tags:
      - Rules
      summary: Validate a rule name
      description: Validates a rule name against existing rule names. Requires a rule name and business object type in the request. Responds with a Boolean (true if name already exists).
      operationId: Rules_Validate
      parameters:
      - name: ruleName
        in: query
        required: true
        description: rule name to be validated
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: businessObjectType
        in: query
        required: true
        description: the business object type
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      responses:
        '200':
          description: True if the named rule does not exist and is available
          content:
            application/json:
              schema:
                type: boolean
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}:
    delete:
      tags:
      - Rules
      summary: Delete an approval rule
      description: Deletes an approval rule by ID.
      operationId: Rules_DeleteById
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: 'Boolean: Deleted Records Status'
          content:
            application/json:
              schema:
                type: boolean
      security:
      - oauth2: []
      - Bearer: []
    get:
      tags:
      - Rules
      summary: Get an approval rule
      description: Gets an approval rule by ID.
      operationId: Rules_GetById
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: The ApprovalRuleDTO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/activate:
    post:
      tags:
      - Rules
      summary: Activate an approval rule
      description: Activates an approval rule by ID.
      operationId: Rules_Activate
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: The ApprovalRuleDTO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/clone:
    post:
      tags:
      - Rules
      summary: Clone an approval rule
      description: Clone an approval rule by ID.
      operationId: Rules_Clone
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: The ApprovalRuleDTO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/deactivate:
    post:
      tags:
      - Rules
      summary: Deactivate an approval rule
      description: Deactivates an approval rule by ID.
      operationId: Rules_Deactivate
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: The ApprovalRuleDTO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/rule-entries/{ruleEntryId}:
    delete:
      tags:
      - Rules
      summary: Delete an approval rule entry
      description: Deletes an approval rule entry by rule ID and rule entry ID.
      operationId: Rules_DeleteRuleEntryById
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      - name: ruleEntryId
        in: path
        required: true
        description: The approval rule entry ID
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: 'Boolean: True if delete is successful.'
          content:
            application/json:
              schema:
                type: boolean
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/rule-entries/{ruleEntryId}/activate:
    post:
      tags:
      - Rules
      summary: Activate an approval rule entry
      description: Activates an approval rule entry by rule ID and rule entry ID.
      operationId: Rules_ActivateRuleEntryById
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      - name: ruleEntryId
        in: path
        required: true
        description: The approval rule entry ID
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: The ApprovalRule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/rule-entries/{ruleEntryId}/deactivate:
    post:
      tags:
      - Rules
      summary: Deactivate an approval rule entry
      description: Deactivates an approval rule entry by rule ID and rule entry ID.
      operationId: Rules_DeactivateRuleEntryById
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      - name: ruleEntryId
        in: path
        required: true
        description: The approval rule entry ID
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: The ApprovalRule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRuleDTO'
      security:
      - oauth2: []
      - Bearer: []
  /v1/rules/{id}/sequence/{ruleSequenceId}/unreferenced-steps:
    get:
      tags:
      - Rules
      summary: Get rule entry dependencies
      description: Provides rule entries that may be defined as dependencies for the current rule entry.
      operationId: Rules_GetUnreferencedSteps
      parameters:
      - name: id
        in: path
        required: true
        description: The approval rule ID
        schema:
          type: string
        x-position: 1
      - name: ruleSequenceId
        in: path
        required: true
        description: The rule sequence ID
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: Unreferenced rule entry sequences
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - oauth2: []
      - Bearer: []
components:
  schemas:
    ApprovalRule:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          Active:
            type:
            - boolean
            - 'null'
          ApprovalCount:
            type:
            - number
            - 'null'
            format: decimal
          ApprovalPercent:
            type:
            - number
            - 'null'
            format: decimal
          ApprovalPolicy:
            type:
            - string
            - 'null'
          BusinessObject:
            type:
            - string
            - 'null'
          ContinuePolicyApprovalOnAReject:
            type:
            - boolean
            - 'null'
          RuleCriteria:
            type:
            - string
            - 'null'
          CriteriaFieldNames:
            type:
            - string
            - 'null'
          Description:
            type:
            - string
            - 'null'
          Dimension1Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension1ValueType:
            type:
            - string
            - 'null'
          Dimension2Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension2ValueType:
            type:
            - string
            - 'null'
          Dimension3Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension3ValueType:
            type:
            - string
            - 'null'
          Dimension4Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension4ValueType:
            type:
            - string
            - 'null'
          Dimension5Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension5ValueType:
            type:
            - string
            - 'null'
          Dimension6Id:
            oneOf:
            - $ref: '#/components/schemas/ApprovalRuleDimension'
          Dimension6ValueType:
            type:
            - string
            - 'null'
          EffectiveDate:
            type:
            - string
            - 'null'
            format: date-time
          ExpirationDate:
            type:
            - string
            - 'null'
            format: date-time
          MatchRule:
            type:
            - string
            - 'null'
          RuleType:
            type:
            - string
            - 'null'
          Sequence:
            type:
            - number
            - 'null'
            format: double
          StopProcessingMoreRules:
            type:
            - boolean
            - 'null'
          RuleEntries:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApprovalRuleEntry'
    ApprovalRuleDTO:
      allOf:
      - $ref: '#/components/schemas/ApprovalRule'
      - type: object
        additionalProperties: {}
        properties:
          RuleEntries:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApprovalRuleEntryDTO'
    SortDirection:
      type: string
      description: ''
      x-enumNames:
      - ASC
      - DESC
      enum:
      - ASC
      - DESC
    ApprovalRuleAssignee:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          Id:
            type:
            - string
            - 'null'
          Name:
            type:
            - string
            - 'null'
          NotifyOnly:
            type: boolean
          RuleEntryId:
            oneOf:
            - $ref: '#/components/schemas/LookupObject'
          SendEmail:
            type: boolean
          SendChat:
            type:
            - boolean
            - 'null'
          CustomAssignee:
            type:
            - string
            - 'null'
          AssigneeId:
            type:
            - string
            - 'null'
          AssigneeType:
            type:
            - string
            - 'null'
          AssigneeDependsOn:
            type:
            - string
            - 'null'
          AssigneeSequence:
            type: number
            format: double
          AssigneeDescription:
            type:
            - string
            - 'null'
          AutoComplete:
            type: boolean
          SkipUnresolvedAssignee:
            type: boolean
          EscalationEnabled:
            type:
            - boolean
            - 'null'
          ReminderEnabled:
            type:
            - boolean
            - 'null'
          Escalation:
            oneOf:
            - $ref: '#/components/schemas/Escalation'
          Reminders:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/Reminder'
    EscalationDTO:
      type: object
      additionalProperties: false
      properties:
        EscalationLevel:
          type:
          - integer
          - 'null'
          format: int32
        Days:
          type: integer
          format: int32
        Hours:
          type: integer
          format: int32
        Minutes:
          type: integer
          format: int32
        EscalationToId:
          type:
          - string
          - 'null'
        EscalationToType:
          type:
          - string
          - 'null'
        EscalationToName:
          type:
          - string
          - 'null'
        CustomAssignee:
          oneOf:
          - $ref: '#/components/schemas/CustomAssigneePayload'
        Id:
          type:
          - string
          - 'null'
    ApprovalRuleEntry:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          ApprovalRuleAssignees:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApprovalRuleAssignee'
          Active:
            type:
            - boolean
            - 'null'
          ApprovalRuleId:
            oneOf:
            - $ref: '#/components/schemas/LookupObject'
          AutoReapprovalCriteria:
            type:
            - string
            - 'null'
          AutoReapprove:
            type:
            - boolean
            - 'null'
          Condition:
            type:
            - string
            - 'null'
          ConditionFieldNames:
            type:
            - string
            - 'null'
          CriteriaFieldNames:
            type:
            - string
            - 'null'
          DependsOn:
            type:
            - string
            - 'null'
          Description:
            type:
            - string
            - 'null'
          Dimension1Value:
            type:
            - string
            - 'null'
          Dimension2Value:
            type:
            - string
            - 'null'
          Dimension3Value:
            type:
            - string
            - 'null'
          Dimension4Value:
            type:
            - string
            - 'null'
          Dimension5Value:
            type:
            - string
            - 'null'
          Dimension6Value:
            type:
            - string
            - 'null'
          EntryLabel:
            type:
            - string
            - 'null'
          IncludePrevious:
            type:
            - boolean
            - 'null'
          Value:
            type:
            - string
            - 'null'
          ValueType:
            type:
            - string
            - 'null'
          Sequence:
            type:
            - number
            - 'null'
            format: double
          SequenceVisual:
            type:
            - number
            - 'null'
            format: decimal
          DependencyKey:
            type:
            - string
            - 'null'
    Reminder:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          Sequence:
            type:
            - integer
            - 'null'
            format: int32
          TimeDuration:
            type: integer
            format: int32
          TimeDurationUnit:
            type:
            - string
            - 'null'
          ReminderForId:
            type:
            - string
            - 'null'
          ReminderForType:
            type:
            - string
            - 'null'
    CustomAssigneePayload:
      type: object
      description: CustomAssigneePayload
      additionalProperties: false
      properties:
        CustomObject:
          type: string
          description: CustomObject
        CustomField:
          type: string
          description: CustomField
        CustomAssigneeAdvancedLogic:
          type:
          - string
          - 'null'
          description: CustomAssigneeAdvancedLogic
        AssigneeNameExpression:
          type:
          - string
          - 'null'
          description: Parsed Expression to be shown in UI
        FreeFormEnabled:
          type: boolean
          description: Custom object filter free form expression
        FreeFormExpression:
          type:
          - string
          - 'null'
          description: FreeFormExpression
        CustomAssigneeFilters:
          type:
          - array
          - 'null'
          description: Custom assignee filters
          items:
            $ref: '#/components/schemas/CustomAssigneeFilterPayload'
    ApprovalRuleDimension:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        required:
        - Name
        - BusinessObject
        - Datasource
        - DimensionType
        properties:
          Name:
            type: string
            minLength: 1
          BusinessObject:
            type: string
            minLength: 1
          Datasource:
            type: string
            minLength: 1
          Description:
            type:
            - string
            - 'null'
          DimensionType:
            type: string
            minLength: 1
    LookupObject:
      type: object
      additionalProperties: false
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
    BaseObject:
      type: object
      additionalProperties: {}
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          oneOf:
          - $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          oneOf:
          - $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        CustomProperties:
          type:
          - object
          - 'null'
          additionalProperties: {}
    ApprovalRuleAssigneeDTO:
      allOf:
      - $ref: '#/components/schemas/ApprovalRuleAssignee'
      - type: object
        additionalProperties: {}
        properties:
          CustomAssigneePayload:
            oneOf:
            - $ref: '#/components/schemas/CustomAssigneePayload'
          Escalation:
            oneOf:
            - $ref: '#/components/schemas/EscalationDTO'
          Reminders:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ReminderDTO'
    ReminderDTO:
      type: object
      additionalProperties: false
      properties:
        Name:
          type:
          - string
          - 'null'
        Sequence:
          type:
          - integer
          - 'null'
          format: int32
        Days:
          type: integer
          format: int32
        Hours:
          type: integer
          format: int32
        Minutes:
          type: integer
          format: int32
        Id:
          type:
          - string
          - 'null'
    Escalation:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          EscalationLevel:
            type:
            - integer
            - 'null'
            format: int32
          TimeDuration:
            type: integer
            format: int32
          EscalationForId:
            type:
            - string
            - 'null'
          EscalationForType:
            type:
            - string
            - 'null'
          EscalationToId:
            type:
            - string
            - 'null'
          EscalationToType:
            type:
            - string
            - 'null'
          EscalationToName:
            type:
            - string
            - 'null'
          CustomAssignee:
            type:
            - string
            - 'null'
          StepId:
            type:
            - string
            - 'null'
          Rule:
            type:
            - string
            - 'null'
          RuleStep:
            type:
            - string
            - 'null'
          ExpectedDaysToComplete:
            type:
            - string
            - 'null'
          ExpectedHoursToComplete:
            type:
            - string
            - 'null'
          ExpectedMinutesToComplete:
            type:
            - string
            - 'null'
    ApprovalRuleEntryDTO:
      allOf:
      - $ref: '#/components/schemas/BaseObject'
      - type: object
        additionalProperties: {}
        properties:
          RuleAssignees:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApprovalRuleAssigneeDTO'
          ApprovalRuleAssignees:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApprovalRuleAssignee'
          Active:
            type:
            - boolean
            - 'null'
          ApprovalRuleId:
            oneOf:
            - $ref: '#/components/schemas/LookupObject'
          AutoReapprovalCriteria:
            type:
            - string
            - 'null'
          AutoReapprove:
            type:
            - boolean
            - 'null'
          Condition:
            type:
            - string
            - 'null'
          ConditionFieldNames:
            type:
            - string
            - 'null'
          CriteriaFieldNames:
            type:
            - string
            - 'null'
          DependsOn:
            type:
            - string
            - 'null'
          Description:
            type:
            - string
            - 'null'
          Dimension1Value:
            type:
            - string
            - 'null'
          Dimension2Value:
            type:
            - string
            - 'null'
          Dimension3Value:
            type:
            - string
            - 'null'
          Dimension4Value:
            type:
            - string
            - 'null'
          Dimension5Value:
            type:
            - string
            - 'null'
          Dimension6Value:
            type:
            - string
            - 'null'
          EntryLabel:
            type:
            - string
            - 'null'
          IncludePrevious:
            type:
            - boolean
            - 'null'
          Value:
            type:
            - string
            - 'null'
          ValueType:
            type:
            - string
            - 'null'
          Sequence:
            type:
            - number
            - 'null'
            format: double
          SequenceVisual:
            type:
            - number
            - 'null'
            format: decimal
          DependencyKey:
            type:
            - string
            - 'null'
    ApprovalsAPIResponseOfListOfApprovalRule:
      type: object
      additionalProperties: false
      properties:
        Success:
          type: boolean
          description: Whether or not the request was successful
        RecordCount:
          type:
          - integer
          - 'null'
          description: The total number of records
          format: int64
        TotalTime:
          type: number
          description: The total time taken
          format: float
        Data:
          type:
          - array
          - 'null'
          description: The list of items
          items:
            $ref: '#/components/schemas/ApprovalRule'
        Errors:
          type:
          - array
          - 'null'
          description: The list of errors
          items:
            $ref: '#/components/schemas/ErrorDetail'
        StatusCode:
          type: integer
          description: The HTTP status code
          format: int32
        HasMoreRecords:
          type:
          - boolean
          - 'null'
          description: Whether or not the result has more records
    ErrorDetail:
      type: object
      additionalProperties: false
      properties:
        Message:
          type:
          - string
          - 'null'
    CustomAssigneeFilterPayload:
      type: object
      description: CustomAssigneeFilterPayload
      additionalProperties: false
      properties:
        FilterFieldName:
          type:
          - string
          - 'null'
        FilterFieldNameType:
          type:
          - string
          - 'null'
        FilterFieldNameRefTo:
          type:
          - string
          - 'null'
        FilterFieldOperator:
          type:
          - string
          - 'null'
        FilterFieldValue:
          type:
          - string
          - 'null'
        FilterFieldValueBindField:
          type:
          - string
          - 'null'
        UseBindFieldEnabled:
          type: boolean
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'Use a JWT Bearer token. (Example: Bearer eyJhbGciO...)'
      name: Authorization
      in: header
    oauth2:
      type: oauth2
      description: Login with a Salesforce or SalesforceSandbox account
      flows:
        authorizationCode:
          authorizationUrl: https://login-rls.congacloud.com/api/v1/auth//connect/authorize
          tokenUrl: https://login-rls.congacloud.com/api/v1/auth//connect/token
          scopes:
            openid: openid
            profile: profile
            offline_access: offline_access
            Auth.Api.Platform: Auth.Api.Platform