Boomi MFT - File Sharing API Reference (1.16) - Favorites

Toggle Pane

• Favorites Service
  • putAdd Folder to Favorites
  • delDelete Folder from Favorites
  • putAdd File to Favorites
  • delDelete File from Favorites
  • getRetrieve All Content in Favorites
  • getRetrieve Files in Favorites
  • getRetrieve Folders in Favorites

API docs by Redocly

Download OpenAPI Specification: Download

Favorites Service

The Favorites REST Web Services provide endpoints for managing and retrieving user-designated favorite items within the file system. These APIs enable the addition or removal of specific files or folders from the favorites list by their unique identifiers, as well as the retrieval of collections of favorite files, folders, or both, with optional filtering parameters.

Add Folder to Favorites

Add folder with the specified id to favorites.

Invocation Scenarios

Mark folder whose ID is specified in URL as favorite

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Favorites/Folder/{folderId}

Delete Folder from Favorites

Remove folder with the specified ID from favorites.

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Favorites/Folder/{folderId}

Add File to Favorites

Add file with the specified ID to favorites.

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Favorites/File/{fileId}

Delete File from Favorites

Remove file with the specified ID from favorites.

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Favorites/File/{fileId}

Retrieve All Content in Favorites

Retrieves a collection of file and folder information structures marked as favorites. Result can be filtered by options.

Authorizations:

SessionAuth

Responses

Response Schema: application/json

	Array of objects (ThruPublicFileInfo) Collection of file information structures
	Array of objects (ThruPublicFolderInfo) Collection of folder information structures

https://{MFTWebServer}/REST/{version}/Favorites/Content

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Retrieve Files in Favorites

Retrieves a collection of file information structures marked as favorites. Result can be filtered by options.

Authorizations:

SessionAuth

Responses

Response Schema: application/json

	Array of objects (ThruPublicFileInfo) Collection of file information structures
	Array of objects (ThruPublicFolderInfo) Collection of folder information structures

https://{MFTWebServer}/REST/{version}/Favorites/Content/Files

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Retrieve Folders in Favorites

Retrieves a collection of folder information structures marked as favorites. Result can be filtered by options.

Authorizations:

SessionAuth

Responses

Response Schema: application/json

	Array of objects (ThruPublicFileInfo) Collection of file information structures
	Array of objects (ThruPublicFolderInfo) Collection of folder information structures

https://{MFTWebServer}/REST/{version}/Favorites/Content/Folders

Response samples

• 200

Content type

application/json

{

• "Files": [

  • {

    • "FileID": "2OMFYXLA6BP9D",
    • "ParentFolderID": "1UTXM50KW0ISP",
    • "Name": "2.html",
    • "Description": "string",
    • "Path": "FOLDERS/HOME/Admin/My Documents/2.html",
    • "Tags": [

      • "string"

      ],
    • "Size": 198,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1346072694480)/",
    • "DateModified": "/Date(1346072694480)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "IsQuarantined": false,
    • "InFavorite": false,
    • "IsPartiallyUploaded": false

    }

  ],
• "Folders": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}