Jump to

• Request
• Response

Upload a temporary file

post

/rest/v1/files

You can upload a temporary file to the Narrative Reporting repository: * The maximum upload size for a temporary file is 256MB. * Temporary files will be deleted during the daily maintenance window.

Request

There are no request parameters for this operation.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)

{
    "properties":{
        "file":{
            "type":"string",
            "format":"binary"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The file uploaded successfully.

Body ()

Root Schema : File

Type: object

Temporary Repository File

Show Source

• id: string
  Read Only: true

  The UUID of the temporary file in the repository.
• links: array links
  Read Only: true
• name: string
  Read Only: true

  The name of the temporary file.
• size: integer
  Read Only: true

  The size of the temporary file.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The UUID of the temporary file in the repository.",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/FileLink"
            }
        },
        "name":{
            "type":"string",
            "description":"The name of the temporary file.",
            "readOnly":true
        },
        "size":{
            "type":"integer",
            "description":"The size of the temporary file.",
            "readOnly":true
        }
    },
    "description":"Temporary Repository File"
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object FileLink

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/FileLink"
    }
}

Nested Schema : FileLink

Type: object

Show Source

• href: string
  Read Only: true
• rel: string
  Read Only: true

  Allowed Values: [ "self" ]

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "readOnly":true
        },
        "rel":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "self"
            ]
        }
    }
}

400 Response

Invalid parameter

Body ()

Root Schema : ExceptionDetail

Type: object

Detailed exception information.

Show Source

• detail: string
  Human-readable description specific to this occurrence of the problem.
• status: integer
  HTTP status code for this occurrence of the problem, set by the origin server.
• title: string
  Short, human-readable summary of the problem.
• type: string
  Absolute URI [RFC3986] that identifies the problem type.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

500 Response

Service Error

Body ()

Root Schema : ExceptionDetail

Type: object

Detailed exception information.

Show Source

• detail: string
  Human-readable description specific to this occurrence of the problem.
• status: integer
  HTTP status code for this occurrence of the problem, set by the origin server.
• title: string
  Short, human-readable summary of the problem.
• type: string
  Absolute URI [RFC3986] that identifies the problem type.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

Back to Top