| Requires any of the roles: | Client, Admin, Partner |
| POST | /upload_fields |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldName | body | string | No | |
| Required | body | bool? | No | |
| UploadType | body | string | No | |
| Label | body | string | No | |
| UploadSubtype | body | string | No | |
| IsEnabled | body | bool? | No | |
| SortOrder | body | double? | No | |
| Help | body | string | No | |
| Placeholder | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldName | form | string | No | |
| Required | form | bool? | No | |
| UploadType | form | string | No | |
| Label | form | string | No | |
| UploadSubtype | form | string | No | |
| IsEnabled | form | bool? | No | |
| SortOrder | form | double? | No | |
| Help | form | string | No | |
| Placeholder | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /upload_fields HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FieldName: String,
Required: False,
UploadType: String,
Label: String,
UploadSubtype: String,
IsEnabled: False,
SortOrder: 0,
Help: String,
Placeholder: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
FieldName: String,
Required: False,
UploadType: String,
Label: String,
UploadSubtype: String,
IsEnabled: False,
SortOrder: 0,
Help: String,
Placeholder: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}