---
title: "File"
url: "https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543/schemas/File"
---

> Full API specification: https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543.md

# File

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Document Generator API
  version: "1.0"
components:
  schemas:
    FileSource:
      enum:
        - ShareFile
        - Base64String
        - RemoteUrl
      type: string
    File:
      type: object
      properties:
        fileRID:
          type: string
          nullable: true
        fileContainerRID:
          type: string
          nullable: true
        fileId:
          type: string
          nullable: true
        fileName:
          type: string
          nullable: true
        eTag:
          type: string
          nullable: true
        fileSource:
          $ref: "#/components/schemas/FileSource"
        shareFileStreamId:
          type: string
          nullable: true
        createdById:
          type: string
          nullable: true
        createdOnUtc:
          type: string
          format: date-time
        deletedOnUtc:
          type: string
          format: date-time
          nullable: true
        deletedById:
          type: string
          nullable: true
      additionalProperties: false
```