Boomi Platform API Reference (1.0.0) - Folder

Toggle Pane

• Folder
  • postCreates a Folder object
  • getRetrieves an instance of a Folder object
  • postModifies or updates a Folder object
  • delDeletes a Folder object
  • postRetrieves multiple Folder objects by identifier
  • postQueries for a Folder object(s)
  • postRetrieves additional results for a Folder query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Folder

Use the Folder object to programatically return metadata for a specific folder in an account's Component Explorer hierarchy on the interface, such as the full folder path, the folder name, and if it is deleted. The Folder object supports the ability to create, update, delete, and restore deleted folders. Additionally, you can view and set the user role restrictions on the folder.

Note: To use the Create, Update, Delete, and Restore operations, you need to have Build Read and Write Access privileges. If Folder Restrictions are enabled, you need sufficient edit access on the folder and parent folder to use these operations.

Required Privileges

Write access

• Build Read and Write Acccess

Read access

• Build Read Access

Creates a Folder object

• When using the CREATE operation, you can create a new folder within the parent folder.

• When creating a new folder, a name is required but PermittedRoles are optional. Unless it includes a list of UserRoles, in which case the GUID is required for the UserRole.

• parentId must be a valid, non-deleted folder. If omitted or blank, it defaults to the root folder.

• To Restore a folder you need to use the CREATE operation call, using a valid GUID for a deleted item. This will also restore any deleted components within that folder.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (PermittedRoles) Optional. The defined role assigned to the available folder object.
deleted	boolean Read only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPath	string Read only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
id	string Required. Read only. The -generated, unique identifier of the folder.
name	string Required. The user-defined name given to the folder.
parentId	string Required. The -generated, unique identifier of the parent folder.
parentName	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (PermittedRoles) Optional. The defined role assigned to the available folder object.
deleted	boolean Read only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPath	string Read only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
id	string Required. Read only. The -generated, unique identifier of the folder.
name	string Required. The user-defined name given to the folder.
parentId	string Required. The -generated, unique identifier of the parent folder.
parentName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Folder",
• "PermittedRoles": {

  • "@type": "PermittedRoles",
  • "RoleReference": [

    • {

      • "id": "fcb6dd44-0ca8-11e2-a477-1231381987a5"

      }

    ]

  },
• "name": "Folder123",
• "parentId": "Rjo5NjEyNTg"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Folder",
• "PermittedRoles": {

  • "@type": "PermittedRoles",
  • "RoleReference": [

    • {

      • "@type": "RoleReference",
      • "id": "fcb6dd44-0ca8-11e2-a477-1231381987a5",
      • "name": "Administrator"

      }

    ]

  },
• "id": "RjoxMDU2NjMx",
• "name": "Folder123",
• "fullPath": "User/Folder1/Folder123",
• "deleted": false,
• "parentId": "Rjo5NjEyNTg",
• "parentName": "Folder1"

}

Retrieves an instance of a Folder object

Retrieves the folder with the particular ID.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The Boomi-generated, unique identifier of the folder.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (PermittedRoles) Optional. The defined role assigned to the available folder object.
deleted	boolean Read only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPath	string Read only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
id	string Required. Read only. The -generated, unique identifier of the folder.
name	string Required. The user-defined name given to the folder.
parentId	string Required. The -generated, unique identifier of the parent folder.
parentName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Folder",
• "id": "folderId123",
• "name": "Folder-Name",
• "fullPath": "Platform API/Folder/Tests/Folder-Name",
• "deleted": false

}

Modifies or updates a Folder object

You can update by changing the name of the folder and following the same considerations for the CREATE parameters.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The Boomi-generated, unique identifier of the folder.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (PermittedRoles) Optional. The defined role assigned to the available folder object.
deleted	boolean Read only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPath	string Read only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
id	string Required. Read only. The -generated, unique identifier of the folder.
name	string Required. The user-defined name given to the folder.
parentId	string Required. The -generated, unique identifier of the parent folder.
parentName	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (PermittedRoles) Optional. The defined role assigned to the available folder object.
deleted	boolean Read only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPath	string Read only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
id	string Required. Read only. The -generated, unique identifier of the folder.
name	string Required. The user-defined name given to the folder.
parentId	string Required. The -generated, unique identifier of the parent folder.
parentName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Folder",
• "PermittedRoles": {

  • "@type": "PermittedRoles",
  • "RoleReference": [

    • {

      • "id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

      }

    ]

  },
• "id": "RjoxMDU2NTM5",
• "name": "Folder456"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Folder",
• "PermittedRoles": {

  • "@type": "PermittedRoles",
  • "RoleReference": [

    • {

      • "@type": "RoleReference",
      • "id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5",
      • "name": "Standard User"

      }

    ]

  },
• "id": "RjoxMDU2NTM5",
• "name": "Folder456",
• "fullPath": "User/Folder456",
• "deleted": false,
• "parentId": "Rjo5NTk0OTc",
• "parentName": "User"

}

Deletes a Folder object

• Deleting a folder will delete the folder and its contents including all components and sub-folders.
• The root folder cannot be deleted.
• Folders containing actively deployed processes or other deployable components cannot be deleted.

  Note: You can restore a deleted folder by requesting a CREATE operation and specifying the ID of the deleted folder.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The Boomi-generated, unique identifier of the folder.

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple Folder objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (Folder) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "BulkRequest": {

  • "type": "GET",
  • "request": [

    • {

      • "xsi_type": "BulkId",
      • "id": "folderId123"

      },
    • {

      • "xsi_type": "BulkId",
      • "id": "folderId456"

      },
    • {

      • "xsi_type": "BulkId",
      • "id": "folderId789"

      }

    ]

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "BulkResult": {

  • "response": [

    • {

      • "statusCode": "200",
      • "Result": {

        • "xsi_type": "Folder",
        • "id": "folderId123",
        • "name": "Folder-Name",
        • "fullPath": "Platform API/Folder/Tests/Folder-Name",
        • "deleted": "false"

        }

      },
    • {

      • "statusCode": "200",
      • "Result": {

        • "xsi_type": "Folder",
        • "id": "folderId456",
        • "name": "Folder-Name",
        • "fullPath": "Platform API/Folder/Tests/Folder-Name",
        • "deleted": "false"

        }

      },
    • {

      • "statusCode": "200",
      • "Result": {

        • "xsi_type": "Folder",
        • "id": "folderId789",
        • "name": "Folder-Name",
        • "fullPath": "Platform API/Folder/Tests/Folder-Name",
        • "deleted": "false"

        }

      }

    ]

  }

}

Queries for a Folder object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

• You can perform the QUERY operation for the Folder object by id, name, fullPath and deleted.

• The QUERY MORE operation is also available for the Folder object.

• You can perform an empty QUERY to return all folders.

• If no filter is specified, both non-deleted and deleted records are returned.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: accountId, id, name, fullPath, deleted, parentId, parentName, permittedRoles

required

object

required FolderSimpleExpression (object) or FolderGroupingExpression (object) (FolderExpression) One of operator required string Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" property required string Enum: "accountId" "id" "name" "fullPath" "deleted" "parentId" "parentName" "permittedRoles" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (Folder)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "operator": "and",
    • "nestedExpression": [

      • {

        • "operator": "EQUALS",
        • "property": "name",
        • "argument": [

          • "SOAP and Platform API Connector"

          ]

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "Folder",
    • "id": "folderId123",
    • "name": "SOAP and Platform API Connector",
    • "fullPath": "API Regression/Tests/SOAP and Platform API Connector",
    • "deleted": false

    }

  ],
• "numberOfResults": 1

}

Retrieves additional results for a Folder query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (Folder)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/Folder/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "Folder",
    • "id": "folderId123",
    • "name": "SOAP and Platform API Connector",
    • "fullPath": "API Regression/Tests/SOAP and Platform API Connector",
    • "deleted": false

    }

  ],
• "numberOfResults": 1

}