POSTpartial

File a Rule 4.7 replacement or response

Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Requires submission:create for a partner and the current own-side Rule 4.7 window.

/api/cases/{id}/submissions/{submissionId}/replacementsfileReplacementPreview

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalSession

CanonicalPartnerBearer

AccountOAuth

Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}
submissionIdpathRequired{"type":"string"}
Idempotency-Key

Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts.

headerOptional{"type":"string"}
kindqueryOptional{"type":"string","enum":["replacement","response"],"default":"replacement"}

Request body

Required request body.

multipart/form-data

{
  "$ref": "#/components/schemas/CanonicalReplacementForm",
  "type": "object",
  "required": [
    "party",
    "brief"
  ],
  "properties": {
    "party": {
      "type": "string",
      "enum": [
        "claimant",
        "respondent"
      ]
    },
    "brief": {
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "contentEncoding": "binary"
      }
    },
    "evidenceCandidateRefs": {
      "type": "string",
      "description": "JSON array of exportRecordId and artifactRef objects."
    },
    "attest": {
      "type": "string",
      "const": "true",
      "description": "Required for hosted session declarations; not accepted by the bearer endpoint."
    },
    "declarantName": {
      "type": "string"
    },
    "declarantCapacity": {
      "type": "string"
    },
    "executionLocation": {
      "type": "string"
    }
  }
}

Responses

201

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalFileReplacementPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalSubmissionResult",
      "type": "object",
      "properties": {
        "schemaVersion": {
          "type": "string"
        },
        "submission": {
          "$ref": "#/components/schemas/CanonicalSubmission",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "disputeId": {
              "type": "string"
            },
            "party": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            },
            "brief": {
              "type": "string"
            },
            "evidenceIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "submittedAt": {
              "type": "string"
            },
            "phase": {
              "type": "string"
            },
            "sealedAt": {
              "type": "string"
            },
            "revealedAt": {
              "type": "string"
            },
            "contentHash": {
              "type": "string"
            },
            "supersededAt": {
              "type": "string"
            },
            "supersededBy": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "party",
            "brief",
            "evidenceIds",
            "submittedAt"
          ]
        },
        "evidence": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "phase": {
                "type": "string"
              },
              "reliabilityTier": {
                "type": "string"
              },
              "contentHash": {
                "type": "string"
              },
              "extractionError": {
                "type": "string"
              },
              "neutralizedCount": {
                "type": "integer"
              }
            },
            "required": [
              "id",
              "label",
              "phase",
              "reliabilityTier",
              "contentHash",
              "neutralizedCount"
            ]
          }
        },
        "security": {
          "type": "object",
          "properties": {
            "neutralizedCount": {
              "type": "integer"
            },
            "quarantinedExhibits": {
              "type": "integer"
            },
            "attributableTo": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            }
          },
          "required": [
            "neutralizedCount",
            "quarantinedExhibits"
          ]
        },
        "sealed": {
          "type": "boolean"
        },
        "phase": {
          "type": "string"
        },
        "deadlines": {
          "type": "object",
          "properties": {
            "answer": {
              "type": "string"
            },
            "evidence": {
              "type": "string"
            },
            "rebuttal": {
              "type": "string"
            }
          }
        },
        "evidenceCandidateAdoptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "exportRecordId": {
                "type": "string"
              },
              "artifactRef": {
                "type": "string"
              },
              "evidenceObjectId": {
                "type": "string"
              },
              "sourceSha256": {
                "type": "string"
              }
            },
            "required": [
              "exportRecordId",
              "artifactRef",
              "evidenceObjectId",
              "sourceSha256"
            ]
          }
        }
      },
      "required": [
        "submission"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ],
  "x-code-source": "lib/submissions/operations.ts"
}
404

Preview disabled or authorized resource unavailable.

default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "submission": {
      "id": "id_test",
      "party": "claimant",
      "brief": "The attached test record supports this position.",
      "evidenceIds": [
        "evidenceIds_test"
      ],
      "submittedAt": "submittedAt_test"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.