Waiting for engine...
Skip to main content

Folder object

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.

Structure​

<Folder id="" name="" deleted="" fullPath="" permittedRoles="" parentId="">
</Folder>
FieldTypeDescription
FilterFilterFilter
idstringRequired. Read only. The -generated, unique identifier of the folder.
namestringRequired. The user-defined name given to the folder.
deletedstringRead only. Indicates if the component is deleted. A true value indicates a deleted status, whereas a false value indicates an active status.
fullPathstringRead only. The full path of the folder location in which the component most currently resides within the Component Explorer hierarchy.
PermittedRolesstringOptional. The defined role assigned to the available folder object.
parentIdstringRequired. The -generated, unique identifier of the parent folder.

Supported operations​

note

In order 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 will also need sufficient edit access on the folder and parent folder to use these operations.

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Supported Supported  Supported Not SupportedSupported 

Using the GET operation​

  • The Bulk GET operation is also available for the Folder object.

Using the QUERY operation​

  • 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.

Using the CREATE operation​

  • 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.

Using the UPDATE operation​

  • When using the UPDATE operation, an ID is required.

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

Using the DELETE operation​

  • 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.

SOAP implementation​

  • GET operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
    </soapenv:Header>
       <soapenv:Body>
          <api:get>
             <!--Optional:-->
             <api:objectType>folder</api:objectType>
             <!--Optional:-->
             <api:objectId>folderId123</api:objectId>
          </api:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.boomi.com/">
    <bns:result xsi:type="bns:Folder" id="folderId123" name="Folder-Name" fullPath="{conKeyRefs.AtomSphere_BoomiEnterprisePlatform} API/Folder/Tests/Folder-Name" deleted="false"/>
    </bns:getResponse>
    </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns all non-deleted accounts and created between 1/1/14 and 1/1/16.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
    </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <!--Optional:-->
             <api:objectType>folder</api:objectType>
             <!--Optional:-->
             <api:queryConfig>
                         <api:QueryFilter>              
                			<api:expression xsi:type="api:SimpleExpression" operator="EQUALS" property="Id" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       						<!--Zero or more repetitions:-->
      						<api:argument>RjoxNjMxNTA</api:argument>
    					</api:expression>
    				</api:QueryFilter>
             </api:queryConfig>
          </api:query>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getBulkResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.boomi.com/">
             <bns:results>
                <bns:response statusCode="200">
                   <bns:Result xsi:type="bns:Folder" id="folderId123" name="Folder-Name" fullPath="{conKeyRefs.AtomSphere_BoomiEnterprisePlatform} API/Folder/Tests/Folder-Name" deleted="false"/>
                </bns:response>
             </bns:results>
          </bns:getBulkResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <wsse:Username>user@boomi.com</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
    </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <api:create>
    <object xsi:type="api:Folder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" name="Folder123" parentId="Rjo5NTk0OTc">
    <api:permittedRoles>
    <api:Role id="fcb6dd44-0ca8-11e2-a477-1231381987a5"/>\
    </api:permittedRoles>
    </object>
    </api:create>
    </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
    <result xsi:type="bns:Folder" id="RjoxMDU2NTM5" name="Folder123" fullPath="User/Folder123" deleted="false" parentId="Rjo5NTk0OTc" parentName="User">
    <bns:PermittedRoles>
    <bns:RoleReference id="fcb6dd44-0ca8-11e2-a477-1231381987a5" name="Administrator"/>
    </bns:PermittedRoles>
    </result>
    </bns:createResponse>
    </S:Body>
    </S:Envelope>

  • UPDATE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <wsse:Username>user@boomi.com</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
    </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <api:update>
    <object xsi:type="api:Folder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" id="RjoxMDU2NTM5" name="Folder456">
    <api:permittedRoles>
    <api:Role id="fcb6e2d0-0ca8-11e2-a477-1231381987a5"/>\
    </api:permittedRoles>
    </object>
    </api:update>
    </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
    <result xsi:type="bns:Folder" id="RjoxMDU2NTM5" name="Folder456" fullPath="User/Folder456" deleted="false" parentId="Rjo5NTk0OTc" parentName="User">
    <bns:PermittedRoles>
    <bns:RoleReference id="fcb6dd44-0ca8-11e2-a477-1231381987a5" name="Administrator"/>
    </bns:PermittedRoles>
    </result>
    </bns:updateResponse>
    </S:Body>
    </S:Envelope>

  • DELETE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.boomi.com/">
    <soapenv:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <wsse:Username>user@boomi.com</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
    </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <api:delete>
    <!--Optional:-->
    <api:objectType>folder</api:objectType>
    <!--Optional:-->
    <api:objectId>folderId123</api:objectId>
    </api:delete>
    </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <true/>

  • RESTORE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <wsse:Username>User@boomi.com</wsse:Username>
    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
    </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <api:create>
    <object xsi:type="api:Folder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" id="RjoxMDU2NTM5">
    </object>
    </api:create>
    </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
    <result xsi:type="bns:Folder" id="RjoxMDU2NTM5" name="Folder456" fullPath="User/Folder456" deleted="false" parentId="Rjo5NTk0OTc" parentName="User">
    <bns:PermittedRoles>
    <bns:RoleReference id="fcb6dd44-0ca8-11e2-a477-1231381987a5" name="Administrator"/>
    </bns:PermittedRoles>
    </result>
    </bns:createResponse>
    </S:Body>
    </S:Envelope>
On this Page