Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Obligations Fulfillment API

8 actions 8 updates phrasing extends openapi/conga-contract-obligations-fulfillment-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/clm/v1/contracts/obligations/fulfillments/query'].post
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/activityhistory/query'].post
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/query'].post
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}'].get
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}'].put
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}/history/query'].post
$.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}/{fulfillmentAction}'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Contract Obligations Fulfillment API
  version: 1.0.0
extends: openapi/conga-contract-obligations-fulfillment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/clm/v1/contracts/obligations/fulfillments/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List active obligation fulfillments across contracts
      effect: read
      questions:
      - Which obligation fulfillments are still pending or overdue across all my contracts?
      - Can I pull the Manage Fulfillment list without canceled or superseded records?
      - How do I get a total count of active fulfillments?
      instructions:
      - text: List all active obligation fulfillments across contracts matching {CriteriaExpression}.
        slots:
          CriteriaExpression: requestBody.CriteriaExpression
      - text: Show the org-wide Manage Fulfillment listing, {Limit} rows with a total count.
        slots:
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/activityhistory/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Get activity history across an obligation's fulfillments
      effect: read
      questions:
      - Who acted on the fulfillments of a contract obligation, and when?
      - Can I see the combined activity log for every fulfillment of one obligation?
      instructions:
      - text: Show the combined activity history for obligation {obligationId} on contract {contractId}.
        slots:
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Get the activity trail across all fulfillments of obligation {obligationId} in contract {contractId}, {Limit} rows.
        slots:
          obligationId: path.obligationId
          contractId: path.contractId
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List fulfillments for a contract obligation
      effect: read
      questions:
      - What fulfillment records exist for one obligation on a contract?
      - Can I filter an obligation's fulfillments by my own criteria?
      instructions:
      - text: List the fulfillments of obligation {obligationId} on contract {contractId}.
        slots:
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Find fulfillments of obligation {obligationId} in contract {contractId} matching {CriteriaExpression}.
        slots:
          obligationId: path.obligationId
          contractId: path.contractId
          CriteriaExpression: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract obligation fulfillment
      effect: read
      questions:
      - What are the details of one specific obligation fulfillment?
      - How do I look up a fulfillment record by its ID?
      instructions:
      - text: Fetch fulfillment {fulfillmentId} of obligation {obligationId} on contract {contractId}.
        slots:
          fulfillmentId: path.fulfillmentId
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Show the single fulfillment record {fulfillmentId} for contract {contractId}, obligation {obligationId}.
        slots:
          fulfillmentId: path.fulfillmentId
          contractId: path.contractId
          obligationId: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract obligation fulfillment
      effect: write
      questions:
      - Can I edit field values on an existing obligation fulfillment?
      - Which call modifies a fulfillment record directly rather than running an action on it?
      instructions:
      - text: Update fields on fulfillment {fulfillmentId} of obligation {obligationId} in contract {contractId}.
        slots:
          fulfillmentId: path.fulfillmentId
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Edit the stored values of fulfillment record {fulfillmentId} on contract {contractId}, obligation {obligationId}.
        slots:
          fulfillmentId: path.fulfillmentId
          contractId: path.contractId
          obligationId: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}/history/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the history of one fulfillment
      effect: read
      questions:
      - What changes have been made to one particular obligation fulfillment?
      - Can I see the history of a single fulfillment rather than the whole obligation?
      instructions:
      - text: Show the history of fulfillment {fulfillmentId} for obligation {obligationId} on contract {contractId}.
        slots:
          fulfillmentId: path.fulfillmentId
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Get {Limit} history entries for just fulfillment {fulfillmentId} of contract {contractId}, obligation {obligationId}.
        slots:
          Limit: requestBody.Limit
          fulfillmentId: path.fulfillmentId
          contractId: path.contractId
          obligationId: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/fulfillments/{fulfillmentId}/{fulfillmentAction}'].post
  update:
    x-apievangelist-phrasing:
      intent: Perform an action on an obligation fulfillment
      effect: write
      questions:
      - How do I mark an obligation fulfillment as fulfilled with a date and comments?
      - Can I attach supporting documents when acting on a fulfillment?
      instructions:
      - text: Run action {fulfillmentAction} on fulfillment {fulfillmentId} of obligation {obligationId} in contract {contractId}.
        slots:
          fulfillmentAction: path.fulfillmentAction
          fulfillmentId: path.fulfillmentId
          obligationId: path.obligationId
          contractId: path.contractId
      - text: Apply {fulfillmentAction} to fulfillment {fulfillmentId} (contract {contractId}, obligation {obligationId}) fulfilled on {fulfilledOn}.
        slots:
          fulfillmentAction: path.fulfillmentAction
          fulfillmentId: path.fulfillmentId
          contractId: path.contractId
          obligationId: path.obligationId
          fulfilledOn: requestBody.fulfilledOn
      method: generated
      generated: '2026-10-01'