For the complete documentation index, see llms.txt. This page is also available as Markdown.

Governance Rule

Creates a new GovernanceRule.

post

Only administrators can create GovernanceRules.

Path parameters
strTokenstringRequired
Body

Specifications of a GovernanceRule object.

ruleIDstring · nullableOptional

GovernanceRule ID. Unique and assigned by the system. Returned during Get operations. Ignored in other cases.

tenantIDstring · nullableOptional

Tenant ID this GovernanceRule belongs to. Returned during Get operations. Ignored in other cases.

titlestring · min: 1 · max: 255Required

Short title of the rule. Required.

textstring · min: 1Required

Full text of the rule, injected in the agent's system prompt. Required.

categoryIDstring · min: 1Required

ID of a default or tenant-defined GovernanceRuleCategory. Required.

categoryNamestring · nullableOptional

Name of the selected category. Returned during Get operations and ignored in writes.

rationalestring · min: 1Required

Rationale explaining why this rule exists. Required.

normRefstring · nullableOptional

Optional reference to a norm/regulation this rule derives from.

statusstring · min: 1Required

One of: Active, Draft. Required.

scopeTypestring · min: 1Required

One of: All, MemoriCategories, List, AllExcept. Required.

scopeMemoriCategoriesstring[] · nullableOptional

Categories to match against Memori.Categories. Used only when ScopeType is MemoriCategories.

scopeMemoriIDsstring[] · nullableOptional

IDs (backend Memori IDs) this rule applies to. Used only when ScopeType is List.

createdByUserIDstring · nullableOptional

User ID who created this rule. Returned during Get operations. Ignored in other cases.

updatedByUserIDstring · nullableOptional

User ID who last updated this rule. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time · nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time · nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses
200

Success

application/json

Response of a Create GovernanceRule request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post/api/v2/GovernanceRule/{strToken}
POST /api/v2/GovernanceRule/{strToken} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 497

{
  "ruleID": "text",
  "tenantID": "text",
  "title": "text",
  "text": "text",
  "categoryID": "text",
  "categoryName": "text",
  "rationale": "text",
  "normRef": "text",
  "status": "text",
  "scopeType": "text",
  "scopeMemoriCategories": [
    "text"
  ],
  "scopeMemoriIDs": [
    "text"
  ],
  "exclusions": [
    {
      "memoriID": "text",
      "reason": "text",
      "createdByUserID": "text",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "createdByUserID": "text",
  "updatedByUserID": "text",
  "creationTimestamp": "2026-01-01T00:00:00.000Z",
  "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
}
200

Success

{
  "governanceRule": {
    "ruleID": "text",
    "tenantID": "text",
    "title": "text",
    "text": "text",
    "categoryID": "text",
    "categoryName": "text",
    "rationale": "text",
    "normRef": "text",
    "status": "text",
    "scopeType": "text",
    "scopeMemoriCategories": [
      "text"
    ],
    "scopeMemoriIDs": [
      "text"
    ],
    "exclusions": [
      {
        "memoriID": "text",
        "reason": "text",
        "createdByUserID": "text",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "createdByUserID": "text",
    "updatedByUserID": "text",
    "creationTimestamp": "2026-01-01T00:00:00.000Z",
    "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a GovernanceRule by ID.

get

Only administrators can get GovernanceRules.

Path parameters
strTokenstringRequired
strRuleIDstringRequired
Responses
200

Success

application/json

Response of a Get GovernanceRule request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get/api/v2/GovernanceRule/{strToken}/{strRuleID}
GET /api/v2/GovernanceRule/{strToken}/{strRuleID} HTTP/1.1
Accept: */*
200

Success

{
  "governanceRule": {
    "ruleID": "text",
    "tenantID": "text",
    "title": "text",
    "text": "text",
    "categoryID": "text",
    "categoryName": "text",
    "rationale": "text",
    "normRef": "text",
    "status": "text",
    "scopeType": "text",
    "scopeMemoriCategories": [
      "text"
    ],
    "scopeMemoriIDs": [
      "text"
    ],
    "exclusions": [
      {
        "memoriID": "text",
        "reason": "text",
        "createdByUserID": "text",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "createdByUserID": "text",
    "updatedByUserID": "text",
    "creationTimestamp": "2026-01-01T00:00:00.000Z",
    "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes a GovernanceRule.

delete

Only administrators can delete GovernanceRules.

Path parameters
strTokenstringRequired
strRuleIDstringRequired
Responses
200

Success

application/json

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

delete/api/v2/GovernanceRule/{strToken}/{strRuleID}
DELETE /api/v2/GovernanceRule/{strToken}/{strRuleID} HTTP/1.1
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing GovernanceRule.

patch

Only administrators can update GovernanceRules. Fields left null are not changed; ScopeType, if provided, replaces the whole scope (ScopeMemoriCategories/ScopeMemoriIDs/Exclusions).

Path parameters
strTokenstringRequired
strRuleIDstringRequired
Body

Specifications of a GovernanceRule object.

ruleIDstring · nullableOptional

GovernanceRule ID. Unique and assigned by the system. Returned during Get operations. Ignored in other cases.

tenantIDstring · nullableOptional

Tenant ID this GovernanceRule belongs to. Returned during Get operations. Ignored in other cases.

titlestring · min: 1 · max: 255Required

Short title of the rule. Required.

textstring · min: 1Required

Full text of the rule, injected in the agent's system prompt. Required.

categoryIDstring · min: 1Required

ID of a default or tenant-defined GovernanceRuleCategory. Required.

categoryNamestring · nullableOptional

Name of the selected category. Returned during Get operations and ignored in writes.

rationalestring · min: 1Required

Rationale explaining why this rule exists. Required.

normRefstring · nullableOptional

Optional reference to a norm/regulation this rule derives from.

statusstring · min: 1Required

One of: Active, Draft. Required.

scopeTypestring · min: 1Required

One of: All, MemoriCategories, List, AllExcept. Required.

scopeMemoriCategoriesstring[] · nullableOptional

Categories to match against Memori.Categories. Used only when ScopeType is MemoriCategories.

scopeMemoriIDsstring[] · nullableOptional

IDs (backend Memori IDs) this rule applies to. Used only when ScopeType is List.

createdByUserIDstring · nullableOptional

User ID who created this rule. Returned during Get operations. Ignored in other cases.

updatedByUserIDstring · nullableOptional

User ID who last updated this rule. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time · nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time · nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses
200

Success

application/json

Response of an Update GovernanceRule request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

patch/api/v2/GovernanceRule/{strToken}/{strRuleID}
PATCH /api/v2/GovernanceRule/{strToken}/{strRuleID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 497

{
  "ruleID": "text",
  "tenantID": "text",
  "title": "text",
  "text": "text",
  "categoryID": "text",
  "categoryName": "text",
  "rationale": "text",
  "normRef": "text",
  "status": "text",
  "scopeType": "text",
  "scopeMemoriCategories": [
    "text"
  ],
  "scopeMemoriIDs": [
    "text"
  ],
  "exclusions": [
    {
      "memoriID": "text",
      "reason": "text",
      "createdByUserID": "text",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "createdByUserID": "text",
  "updatedByUserID": "text",
  "creationTimestamp": "2026-01-01T00:00:00.000Z",
  "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
}
200

Success

{
  "governanceRule": {
    "ruleID": "text",
    "tenantID": "text",
    "title": "text",
    "text": "text",
    "categoryID": "text",
    "categoryName": "text",
    "rationale": "text",
    "normRef": "text",
    "status": "text",
    "scopeType": "text",
    "scopeMemoriCategories": [
      "text"
    ],
    "scopeMemoriIDs": [
      "text"
    ],
    "exclusions": [
      {
        "memoriID": "text",
        "reason": "text",
        "createdByUserID": "text",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "createdByUserID": "text",
    "updatedByUserID": "text",
    "creationTimestamp": "2026-01-01T00:00:00.000Z",
    "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists all GovernanceRules for the current tenant.

get

Only administrators can list GovernanceRules.

Path parameters
strTokenstringRequired
Responses
200

Success

application/json

Response of a List GovernanceRules request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get/api/v2/GovernanceRules/{strToken}
GET /api/v2/GovernanceRules/{strToken} HTTP/1.1
Accept: */*
200

Success

{
  "governanceRules": [
    {
      "ruleID": "text",
      "tenantID": "text",
      "title": "text",
      "text": "text",
      "categoryID": "text",
      "categoryName": "text",
      "rationale": "text",
      "normRef": "text",
      "status": "text",
      "scopeType": "text",
      "scopeMemoriCategories": [
        "text"
      ],
      "scopeMemoriIDs": [
        "text"
      ],
      "exclusions": [
        {
          "memoriID": "text",
          "reason": "text",
          "createdByUserID": "text",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "createdByUserID": "text",
      "updatedByUserID": "text",
      "creationTimestamp": "2026-01-01T00:00:00.000Z",
      "lastChangeTimestamp": "2026-01-01T00:00:00.000Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the GovernanceRules applicable to a given Memori (Title and Category only). Intended for a future read-only section in the Memori editor.

get

Only administrators can view applicable GovernanceRules. Never returns Text or Rationale.

Path parameters
strTokenstringRequired
strMemoriIDstringRequired
Responses
200

Success

application/json

Response of a Get Applicable GovernanceRules request (admin-facing, read-only).

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get/api/v2/GovernanceRule/{strToken}/ApplicableFor/{strMemoriID}
GET /api/v2/GovernanceRule/{strToken}/ApplicableFor/{strMemoriID} HTTP/1.1
Accept: */*
200

Success

{
  "applicableRules": [
    {
      "title": "text",
      "categoryID": "text",
      "categoryName": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Last updated