Endpoint: /sites/{siteId}/uploadForms

Returns and updates the upload forms configuration for specific profile

GET
POST

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/uploadForms

GET Body Sample

Copy

### GET the Upload Forms Settings####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/uploadForms/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy

{ "data": [ { "type": "site", "id": "0de7387f-1506-427d-b997-e18bcdb8cbae", "attributes": { "name": "MySite1" },
"links": { "self": "admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae", "metrics": 
"admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae/metrics" } } ], "links": { "self": "admin/v2/sites" } }

GET PowerShell Sample

Copy

###GET Upload Forms Settings###
Write-Output "GET Upload Forms Settings"
Write-Output "-----------------"
#$siteID = "Enter site ID"
$UpFormslist = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/uploadForms" -Method 'GET' -Headers 
$authHeader
Write-Output $UpFormslist | ConvertTo-Json -Depth 25

Method & URL

POST https://[server URL]:[port]/admin/v2/sites/{siteId}/

POST Body Sample

Copy

###
POST https://{{host}}/admin/v2/sites/{{Siteid}}/uploadForms/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "id": "uploadFormName",
    "attributes": {
      "description": "Testing Forms from POST REST API",
      "displayName": "FORM_1",
      "displayInstruction": "Enter Text",
      "enabled": true,
      "showForEachFileUploaded": true,
      "userGroupId": "A0DB9377-92A3-4A38-8C0F-09F268D78FF1",
      "uploadFormElements": [
        {
          "name": "",
          "displayLabel": "FORM_1",
          "type": "string",
          "values": "domain.com",
          "required": true
        }
      ]
    }
  }
}

POST Response Body Sample

Copy

{"data":{"type":"uploadForm","id":"uploadFormName","attributes":{"id":"uploadFormName","type":"uploadForm",
"attributes":{"description":"Testing Forms from POST REST API","displayName":"FORM_1",
"displayInstruction":"Enter Text","enabled":true,"showForEachFileUploaded":true,
"userGroupId":"a0db9377-92a3-4a38-8c0f-09f268d78ff1","uploadFormElements":[{"name":"","displayLabel":"FORM_1",
"type":"String","values":"domain.com","required":true}]}}},
"links":{"self":"/admin/v2/sites/6203305a-d7c6-499e-a59b-81500765f8f2/uploadForm/uploadFormName",
"userGroups":"/admin/v2/sites/6203305a-d7c6-499e-a59b-81500765f8f2/userGroups"}}

POST PowerShell Sample

Copy

$update = 
'{
  "data": {
    "id": "uploadFormName",
    "attributes": {
      "description": "Testing Forms from POST REST API",
      "displayName": "FORM_once",
      "displayInstruction": "Enter Text",
      "enabled": true,
      "showForEachFileUploaded": true,
      "userGroupId": "A0DB9377-92A3-4A38-8C0F-09F268D78FF1",
      "uploadFormElements": [
        {
          "name": "",
          "displayLabel": "FORM_once",
          "type": "string",
          "values": "domain.com",
          "required": true
        }
      ]
    }
  }
}'

$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$postUploadFormsReturn = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/uploadForms" 
-Method 'POST' -Headers $authHeader -Body $update
Write-Output $postUploadFormsReturn | ConvertTo-Json