Download definition file by fileId.
GET/form-definitions/:formDefinitionID/file/:fileID
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true
to use this endpoint.
Download definition file by fileId.
Request
Path Parameters
FormDefinitionID
Form definition ID
FileID
String specifying the hashed name of the uploaded file we are retrieving.
Header Parameters
Default value: true
Use this header to enable this experimental API.
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 503
Returns a file that is referred to by fileID and associated with the formDefinitionID
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
Schema
string
- Schema
Schema
string
- Schema
Schema
string
- Schema
Schema
string
An error with the request occurred
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the authorization occurred
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the user permissions occurred
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the item not found
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
Too many requests
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
DetailCode is the text of the status code returned
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
TrackingID is the request tracking unique identifier
{
"detailCode": "Internal Server Error",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}
An internal server error occurred
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An external service is not available
- application/json
- image/jpeg
- image/png
- application/octet-stream
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}