TABLE OF CONTENTS

  • Parameters
  • Example


ADDITIONAL INFO

  • API Explorer
  • General Information

 

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 XML or JSON.

 

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

 

You may use either JSON or XML formats in your POST 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.


 

Name

Type

Description

Required

Id
 

String

GUID of the folder you'd like to create.


 

Name

String

Name of the folder you'd like to create.

✓

ExternalId

String

External ID of the form you'd like to create.


IsRestricted
 

Boolean

Whether 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

Array

GUID of the object to be included in the folder, ie. Screen or Data Source.


CompanyId

Integer

Your 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 the Postman API Platform.
 

The below example demonstrates how to create a new folder using a POST Folder API call.
 

Request URL

https://secure.appenate.com:443/api/v2/folder

 

Request Body

{

  "Id": "",

  "Name": "Test App 2",

  "ExternalId": "",

  "IsRestricted": false,

  "RestrictToGroup": "",

  "Description": "",

  "CompanyId": 60XXX,

  "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXX"

}