Create survey file - Questra Program docs

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "content_type": "<string>",
    "size_bytes": 1,
    "storage_key": "<string>",
    "status": "pending",
    "visibility": "private",
    "hosting": "questra",
    "upstream_path": "<string>",
    "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "public_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "upstream_only": true,
    "reserved_type": "<string>"
  },
  "upload": {
    "url": "<string>",
    "method": "PUT",
    "headers": {},
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "existingMatch": true
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "content_type": "<string>",
    "size_bytes": 1,
    "storage_key": "<string>",
    "status": "pending",
    "visibility": "private",
    "hosting": "questra",
    "upstream_path": "<string>",
    "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "public_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "upstream_only": true,
    "reserved_type": "<string>"
  },
  "upload": {
    "url": "<string>",
    "method": "PUT",
    "headers": {},
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "existingMatch": true
}

{
  "error": "validation_error",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

POST

/

surveys

/

{surveyId}

/

files

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "content_type": "<string>",
    "size_bytes": 1,
    "storage_key": "<string>",
    "status": "pending",
    "visibility": "private",
    "hosting": "questra",
    "upstream_path": "<string>",
    "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "public_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "upstream_only": true,
    "reserved_type": "<string>"
  },
  "upload": {
    "url": "<string>",
    "method": "PUT",
    "headers": {},
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "existingMatch": true
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "content_type": "<string>",
    "size_bytes": 1,
    "storage_key": "<string>",
    "status": "pending",
    "visibility": "private",
    "hosting": "questra",
    "upstream_path": "<string>",
    "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "public_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "upstream_only": true,
    "reserved_type": "<string>"
  },
  "upload": {
    "url": "<string>",
    "method": "PUT",
    "headers": {},
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "existingMatch": true
}

{
  "error": "validation_error",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

Path Parameters

surveyId

string<uuid>

required

Body

application/json

name

string

required

Minimum string length: 1

Example:

"stimulus-pack.zip"

content_type

string

required

Minimum string length: 1

Example:

"application/zip"

size_bytes

integer

visibility

enum<string>

Bucket visibility. Defaults to private.

Available options:

private,

public

Example:

"private"

content_hash

string

When provided and a ready file with the same hash already exists for the survey, the existing file is returned and no upload URL is issued.

Pattern: ^[a-f0-9]{64}$

Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

Response

Existing ready file reused (content_hash match)

data

object

required

Show child attributes

upload

object | null

required

Show child attributes

existingMatch

boolean

True when an existing ready file matched content_hash and was reused.