Upload new form definition file.

POST 
/form-definitions/:formDefinitionID/upload

Parameter {formDefinitionID} should match a form definition ID.

Request

Path Parameters

formDefinitionID stringrequired
FormDefinitionID
String specifying FormDefinitionID
Example: 00000000-0000-0000-0000-000000000000

multipart/form-data

Body

required

file binaryrequired

File specifying the multipart

Responses

201

Returns a new form definition file

application/json

Schema

Schema

created string

Created is the date the file was uploaded

fileId string

fileId is a unique ULID that serves as an identifier for the form definition file

formDefinitionId string

FormDefinitionID is a unique guid identifying this form definition

Example (from schema)

{
  "created": "2023-07-12T20:14:57.74486Z",
  "fileId": "01FHZXHK8PTP9FVK99Z66GXQTX.png",
  "formDefinitionId": "00000000-0000-0000-0000-000000000000"
}

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"
}

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"
}

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"
}

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"
}

413

An error with payload size too large

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"
}

415

An error with unsupported media type

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"
}

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"
}

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"
}

Loading...