PUT Folder

PUT Folder

This API call allows you to update an existing Folder's properties.

 

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.


/api/v2/folder?format=xml/json


You may use either JSON or XML formats in your PUT request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".

If no ContentType is specified, XML format is assumed. 


All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The POST Folder API allows you to create a new folder in your company account.
The required and optional parameters for a POST call to the Folder API are outlined below.


NameTypeDescriptionRequired
Id
StringGUID of the folder you'd like to update.✓
Name
String
Name of the folder you'd like to update.
ExternalId
String
External ID of the form you'd like to update.
IsRestricted
BooleanWhether or not this Folder restricts user access to its contents.

RestrictToGroup
String
Restrict access to a specific User Group identifier. This only allows access to users in the selected group. Users in this Group will also be able to access all items not assigned to any Groups.

Description
String
Description of the Folder.
Items
ArrayGUID of the object to be included in the folder, ie. Screen or Data Source.
CompanyId
IntegerYour unique Company ID is found on the Organization Setup page of the secure website.
✓
IntegrationKey
String
Your unique Integration Key is found on the Organization Setup page of the secure website.
✓
KeyId
String

The ID of the linked item.


Type
String
['Screen', 'Doc', 'DataSource', 'Folder', 'TaskTemplate']

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.


The below example demonstrates how to update an existing folder using a PUT Folder API call.


Request URL

https://eforms.mobileform.net:443/api/v2/folder



Request Body

{
  "Id": "",
  "Name": "",
  "ExternalId": "",
  "IsRestricted": false,
  "RestrictToGroup": "",
  "Description": "",
  "Items": [
    {
      "KeyId": "",
      "Type": ""
    }
  ],
  "CompanyId": 0,
  "IntegrationKey": ""
}



    • Related Articles

    • DELETE Folder

      The DELETE Folder API allows you to remove an existing folder from a company account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb. The format query string parameter controls the desired response ...

    • PUT User

      TABLE OF CONTENTS PUT Request User Response () User () Response Fields API Usage Example PUT Request The PUT verb allows you to update a single, existing User on the platform. You may use either JSON or XML formats in your request. You indicate this ...

    • GET Folder

      The GET Folder API returns details of the Folder matching the given parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. ...

    • PUT Company

      The Company API allows you to retrieve, create and delete client Companies on the platform. This enables scenarios where Companies created/maintained in other systems (e.g. SAP, Salesforce) can be replicated to the platform automatically. On our ...

    • POST Folder

      The POST Folder API creates a new folder in the company's account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either ...