Sustema

ENTITY developer reference

FeedbackProblem

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

All codes/status/retry/status_path are evaluated on this caller's owned public lifecycle, current authority and submitted request, never hidden coalesced job state. stale_revision/412 compares the owned public revision.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

type

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uri"
Reading definition for type
{
  "type": "string",
  "format": "uri",
  "x-profile-maxLength": "string_characters_max"
}

title

Listed in this schema’s required array.

Declared type
"string"
Reading definition for title
{
  "type": "string",
  "minLength": 1,
  "maxLength": 180,
  "x-profile-maxLength": "string_characters_max"
}

status

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for status
{
  "type": "integer",
  "minimum": 400,
  "maximum": 599
}

code

Listed in this schema’s required array.

Declared type
"string"
Reading definition for code
{
  "type": "string",
  "enum": [
    "invalid_request",
    "unauthenticated",
    "permission_denied",
    "resource_not_found",
    "reference_expired",
    "idempotency_conflict",
    "stale_revision",
    "feedback_closed",
    "rate_limited",
    "payload_too_large",
    "dependency_unavailable",
    "operation_reconciling",
    "internal_error",
    "operation_timeout",
    "completion_uncertain",
    "concurrency_limited",
    "authority_revoked",
    "entitlement_denied",
    "limit_out_of_range"
  ],
  "x-profile-maxLength": "string_characters_max"
}

request_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for request_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

feedback_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for feedback_id
{
  "anyOf": [
    {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

retry_action

Listed in this schema’s required array.

Declared type
"string"
Reading definition for retry_action
{
  "type": "string",
  "enum": [
    "correct_request",
    "reauthenticate",
    "do_not_retry",
    "retry_same_submission",
    "read_current_report",
    "poll_owned_report"
  ],
  "x-profile-maxLength": "string_characters_max"
}

status_path

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for status_path
{
  "anyOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 240,
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

customer_debit_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for customer_debit_units
{
  "const": "0"
}

delivery_limit

Not listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for delivery_limit
{
  "$ref": "#/components/schemas/DeliveryLimitGuidance"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "x-profile-maxLength": "string_characters_max"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 180,
      "x-profile-maxLength": "string_characters_max"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string",
      "enum": [
        "invalid_request",
        "unauthenticated",
        "permission_denied",
        "resource_not_found",
        "reference_expired",
        "idempotency_conflict",
        "stale_revision",
        "feedback_closed",
        "rate_limited",
        "payload_too_large",
        "dependency_unavailable",
        "operation_reconciling",
        "internal_error",
        "operation_timeout",
        "completion_uncertain",
        "concurrency_limited",
        "authority_revoked",
        "entitlement_denied",
        "limit_out_of_range"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "feedback_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "retry_action": {
      "type": "string",
      "enum": [
        "correct_request",
        "reauthenticate",
        "do_not_retry",
        "retry_same_submission",
        "read_current_report",
        "poll_owned_report"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "status_path": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 240,
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "customer_debit_units": {
      "const": "0"
    },
    "delivery_limit": {
      "$ref": "#/components/schemas/DeliveryLimitGuidance"
    }
  },
  "required": [
    "type",
    "title",
    "status",
    "code",
    "request_id",
    "feedback_id",
    "retry_action",
    "status_path",
    "customer_debit_units"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "code": {
            "const": "invalid_request"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 400
          },
          "retry_action": {
            "const": "correct_request"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "unauthenticated"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 401
          },
          "retry_action": {
            "const": "reauthenticate"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "permission_denied"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 403
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "resource_not_found"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 404
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "reference_expired"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 410
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "idempotency_conflict"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 409
          },
          "retry_action": {
            "const": "correct_request"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "stale_revision"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 412
          },
          "retry_action": {
            "const": "read_current_report"
          },
          "feedback_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          },
          "status_path": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240,
            "pattern": "^/v1/feedback/",
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "feedback_closed"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 409
          },
          "retry_action": {
            "const": "read_current_report"
          },
          "feedback_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          },
          "status_path": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240,
            "pattern": "^/v1/feedback/",
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "rate_limited"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 429
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "payload_too_large"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 413
          },
          "retry_action": {
            "const": "correct_request"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "dependency_unavailable"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 503
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "operation_reconciling"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 409
          },
          "retry_action": {
            "const": "poll_owned_report"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "retry_action": {
            "const": "poll_owned_report"
          }
        },
        "required": [
          "retry_action"
        ]
      },
      "then": {
        "properties": {
          "feedback_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          },
          "status_path": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240,
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "internal_error"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 500
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "operation_timeout"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 504
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "completion_uncertain"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 503
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "concurrency_limited"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 429
          },
          "retry_action": {
            "const": "retry_same_submission"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "authority_revoked"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 403
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "entitlement_denied"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 403
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "limit_out_of_range"
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "status": {
            "const": 422
          },
          "retry_action": {
            "enum": [
              "correct_request",
              "do_not_retry"
            ]
          }
        },
        "required": [
          "delivery_limit"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "const": "limit_out_of_range"
          },
          "delivery_limit": {
            "properties": {
              "phase": {
                "const": "delivery"
              }
            },
            "required": [
              "phase"
            ]
          }
        },
        "required": [
          "code",
          "delivery_limit"
        ]
      },
      "then": {
        "properties": {
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "code": {
            "enum": [
              "unauthenticated",
              "permission_denied",
              "authority_revoked",
              "entitlement_denied",
              "resource_not_found"
            ]
          }
        },
        "required": [
          "code"
        ]
      },
      "then": {
        "properties": {
          "feedback_id": {
            "type": "null"
          },
          "status_path": {
            "type": "null"
          }
        }
      }
    }
  ],
  "description": "All codes/status/retry/status_path are evaluated on this caller's owned public lifecycle, current authority and submitted request, never hidden coalesced job state. stale_revision/412 compares the owned public revision."
}

Related schemas

All API operations