Download instance file by fileId.

GET 
/form-instances/:formInstanceID/file/:fileID

Download instance file by fileId.

Request

Path Parameters

formInstanceID stringrequired
FormInstanceID
Form instance ID
Example: 00000000-0000-0000-0000-000000000000
fileID stringrequired
FileID
String specifying the hashed name of the uploaded file we are retrieving.
Example: 00000031N0J7R2B57M8YG73J7M.png

Responses

200

Returns a file that is referred to by fileID and associated with the formInstanceID

application/json

Schema

Schema

string

image/jpeg

Schema

Schema

string

image/png

Schema

Schema

string

application/octet-stream

Schema

Schema

string

400

An error with the request occurred

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

401

An error with the authorization occurred

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

403

An error with the user permissions occurred

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

404

An error with the item not found

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

429

Too many requests

application/json

Schema

Schema

detailCode string

DetailCode is the text of the status code returned

messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
trackingId string

TrackingID is the request tracking unique identifier

Example (from schema)

{
  "detailCode": "Internal Server Error",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}

500

An internal server error occurred

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

503

An external service is not available

application/json

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/jpeg

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

image/png

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

application/octet-stream

Schema

Schema

detailCode string
messages object[]
Array [
locale string
Locale is the current Locale
localeOrigin string
LocaleOrigin holds possible values of how the locale was selected
text string
Text is the actual text of the error message
]
statusCode int64
trackingId string

Example (from schema)

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

Loading...