MANSOQ Knowledge
← This release collection

IT & Integrations · VERSION 39b72767

Read file scope, pagination and direct-upload inputs

Inspect the exact supported file-list and direct structured-upload contract without executing an upload.

IT administrator · Integration engineer · Developer

GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.1234
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Identify both required file-list scope fields

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.

Image SHA-256 3d5806e1721b4c99bdfd826cb335bff04fe4a9270039d3bd79cf4cef519bf096

  1. Required resource identifier: associating_id must identify the resource selected by file_type.
  2. Required resource type: file_type is required: patient, encounter, consent, diagnostic_report or service_request.
  3. Documented enum: The disabled select shows allowed resource types; it is not an execution control.
  4. Limit: Limit controls page size; max_limit 200 is defined by source and contract checks.
POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.123456
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Inspect all six required structured-upload inputs

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.

Image SHA-256 4b15dcfdead539642ca90eb228062f7a708d35dc6cc04231ad5cf24f13585599

  1. Exact operation: Read this direct structured-upload action separately from the presigned create/complete workflow.
  2. Request Schema: Select Schema in Request body.
  3. Original filename and display name: original_name and name are separate required fields.
  4. Type and category: Choose the documented file type and category. MIME is detected from the supplied bytes.
  5. Resource association: associating_id points to the resource named by file_type.
  6. Encoded file bytes: file_data carries encoded bytes. Source decodes bytes and detects MIME; this screenshot contains no file or credential.

6 of 7 content blocks have reviewed image alignment. Missing overview or prerequisite images remain open.

Before you begin

  • Use API documentation for the exact deployed source version. These fresh images show committed release 39b72767 in a local read-only reference; production deployment is separate.
    The actual local documentation metadata response shows full commit and source tree, OpenAPI 3.1, the exact schema fingerprint, path/operation/component counts, verified core count, read-only and zero-query flags, and pinned viewer versions. Local filesystem paths are omitted. This is documentation-render provenance, not a HIMS patient-data response or production deployment receipt.1234567
    Recorded release 39b72767 · 2026-10-19 · 1728 × 921

    Read the privacy-minimized documentation source receipt

    Capture details

    Fresh genuine 1728×921 native Chrome frame of the privacy-minimized local documentation receipt for exact release 39b72767. No pixels were edited. The original full private receipt and earlier frame are preserved separately.

    Image SHA-256 fb12b6ce9985f9712ed8ada1822363dec2d43ebc521a8407615d978ec4fe786d

    1. Exact source release: Compare the full sourceCommit with the documentation release you intend to use.
    2. Exact source tree: The Git source tree identifies the retained committed source.
    3. Schema fingerprint: Compare the complete schema SHA256 with the downloaded contract artifact.
    4. Read-only reference: The actual metadata records a read-only documentation viewer.
    5. Verified core export: This receipt records 1,815 core blobs checked against the commit.
    6. Zero database queries: The documented export rendered without querying application data.
    7. Bounded local scope: This receipt does not establish endpoint execution, tenant compatibility or production deployment.
    The rendered viewer shows read-only banner, MANSOQ API label 1.0.0, OAS 3.1, schema link, tag filter and Authorize button. No credentials were entered; endpoint submission is disabled.1234
    Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

    Find the local read-only API reference

    Capture details

    Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. The rendered viewer shows read-only banner, MANSOQ API label 1.0.0, OAS 3.1, schema link, tag filter and Authorize button. No credentials were entered; endpoint submission is disabled.

    Image SHA-256 252087c750d5f3bde5575c84c42266b2d55b7d3b365822be287880a687dde252

    1. Read-only viewer: Requests are disabled in this documentation viewer.
    2. Schema dialect 3.1: OAS 3.1 is the schema dialect; 1.0.0 is the separate API label, not a Git release.
    3. Download contract: The schema link opens the generated contract for the selected source version.
    4. Find a tag: Filter operations by tag such as files, auth or finance.
  • The viewer disables endpoint submission. Use an approved client and authorized sandbox for actual calls; a schema grants no data access.

1. Supply the resource type and identifier together

GET /api/v1/files/ requires file_type and associating_id. The resource may be patient, encounter, consent, diagnostic_report or service_request. The identifier must belong to the selected resource and authorized scope. file_category, name, is_archived and ordering are optional filters; their presence never overrides authorization.

GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.1234
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Identify both required file-list scope fields

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.

Image SHA-256 3d5806e1721b4c99bdfd826cb335bff04fe4a9270039d3bd79cf4cef519bf096

  1. Required resource identifier: associating_id must identify the resource selected by file_type.
  2. Required resource type: file_type is required: patient, encounter, consent, diagnostic_report or service_request.
  3. Documented enum: The disabled select shows allowed resource types; it is not an execution control.
  4. Limit: Limit controls page size; max_limit 200 is defined by source and contract checks.

2. Page through count and results

Use limit and offset for this paginator. The source caps limit at 200. The response contains count and results and does not provide next/previous navigation URLs. Advance offset explicitly and stop when the returned page is empty or the intended range is complete; retain the filter scope across pages. The displayed values are generated placeholders.

The visible GET files response Example Value shows count and results, plus offset above it. This is a Swagger-generated example, not a saved patient file or actual response body.1234
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Read count/results pagination

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. The visible GET files response Example Value shows count and results, plus offset above it. This is a Swagger-generated example, not a saved patient file or actual response body.

Image SHA-256 7f0f0972273b92115528a0bc5229c75d39c9041912cfc081a8e51bdcd5ff0745

  1. Offset: Offset is the initial result index.
  2. Count: Count is the total matching count in the typed paginator contract.
  3. Results: Read the results array; this paginator does not return next/previous links.
  4. Schema tab: Use Schema to inspect types rather than treating the generated example as live data.
GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.1234
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Identify both required file-list scope fields

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. GET /api/v1/files/ is open. associating_id and file_type visibly carry required markers; disabled fields confirm read-only viewer. A valid pair identifies the resource whose files are requested.

Image SHA-256 3d5806e1721b4c99bdfd826cb335bff04fe4a9270039d3bd79cf4cef519bf096

  1. Required resource identifier: associating_id must identify the resource selected by file_type.
  2. Required resource type: file_type is required: patient, encounter, consent, diagnostic_report or service_request.
  3. Documented enum: The disabled select shows allowed resource types; it is not an execution control.
  4. Limit: Limit controls page size; max_limit 200 is defined by source and contract checks.

3. Inspect the direct upload request before sending bytes

For POST /api/v1/files/upload-file/, all six fields shown by Request Schema are required: original_name, name, file_type, file_category, associating_id, file_data. The action decodes the supplied data and detects MIME from bytes. Read the enums and association carefully. This direct action is distinct from creating a presigned-upload record and later marking completion.

POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.123456
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Inspect all six required structured-upload inputs

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.

Image SHA-256 4b15dcfdead539642ca90eb228062f7a708d35dc6cc04231ad5cf24f13585599

  1. Exact operation: Read this direct structured-upload action separately from the presigned create/complete workflow.
  2. Request Schema: Select Schema in Request body.
  3. Original filename and display name: original_name and name are separate required fields.
  4. Type and category: Choose the documented file type and category. MIME is detected from the supplied bytes.
  5. Resource association: associating_id points to the resource named by file_type.
  6. Encoded file bytes: file_data carries encoded bytes. Source decodes bytes and detects MIME; this screenshot contains no file or credential.

4. Verify the stored result independently in the real workflow

An operation documented here is not proof that an upload completed. In an approved synthetic execution, read the returned identifier, retrieve the file metadata, and compare retained stored bytes to the intended input. An unknown response outcome must be investigated before repeating this non-idempotent direct-upload action. Separate evidence from a prior corrected sandbox verifies a normal Nurse upload, creator/updater metadata and 294 retained bytes; this schema screenshot itself does not.

POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.123456
Recorded release 39b72767 · 2026-10-19 · 1728 × 1080

Inspect all six required structured-upload inputs

Capture details

Fresh 1728×1080 Chrome capture of the installed read-only API reference rendered from committed MANSOQ release 39b72767. This local reference does not establish production product deployment or endpoint execution. POST /api/v1/files/upload-file/ Request Schema displays six required strings: original_name, name, file_type, file_category, associating_id, file_data. No upload was executed in this viewer.

Image SHA-256 4b15dcfdead539642ca90eb228062f7a708d35dc6cc04231ad5cf24f13585599

  1. Exact operation: Read this direct structured-upload action separately from the presigned create/complete workflow.
  2. Request Schema: Select Schema in Request body.
  3. Original filename and display name: original_name and name are separate required fields.
  4. Type and category: Choose the documented file type and category. MIME is detected from the supplied bytes.
  5. Resource association: associating_id points to the resource named by file_type.
  6. Encoded file bytes: file_data carries encoded bytes. Source decodes bytes and detects MIME; this screenshot contains no file or credential.

Source evidence

Every citation uses this exact committed version. The private source repository requires access.