GET Worklist/FavoriteFolders?culture={culture}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
culture

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of FavoriteFolderInfo
NameDescriptionTypeAdditional information
Identifier

Gets or sets the identifier of the worklist

string

None.

FolderId

Gets or sets the UUID.

integer

None.

FolderUuid

Gets or sets the folder UUID.

string

None.

Label

Gets or sets the name of the folder.

string

None.

WorklistType

Object Type of Worklist_favorite

WorklistType

None.

SortOrder

sort order of Worklist_favorite

string

None.

Count

Gets or sets the count of records (applicable only for unread studies based worklists). If more than the cache limit, this value will be ending with + sign.

string

None.

IsStatCount

Gets or sets the prioroty is-stat count.

string

None.

BaseType

Gets or sets the type of the base.

string

None.

IsQbeFolder

Gets or sets the is qbe folder.

string

None.

BaseFolderName

Gets or sets the name of the base folder.

string

None.

IsPublic

Identifies whether the LinkFolder is Public(shared) or not.

boolean

None.

IsShared

boolean

None.

IsGlobal

boolean

None.

Owner

The LoginName of the Owner

string

None.

IsDefault

Gets or sets a value indicating whether this instance is default.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "sample string 1",
    "FolderId": 2,
    "FolderUuid": "sample string 3",
    "Label": "sample string 4",
    "WorklistType": 0,
    "SortOrder": "sample string 5",
    "Count": "sample string 6",
    "IsStatCount": "sample string 7",
    "BaseType": "sample string 8",
    "IsQbeFolder": "sample string 9",
    "BaseFolderName": "sample string 10",
    "IsPublic": true,
    "IsShared": true,
    "IsGlobal": true,
    "Owner": "sample string 14",
    "IsDefault": true
  },
  {
    "Identifier": "sample string 1",
    "FolderId": 2,
    "FolderUuid": "sample string 3",
    "Label": "sample string 4",
    "WorklistType": 0,
    "SortOrder": "sample string 5",
    "Count": "sample string 6",
    "IsStatCount": "sample string 7",
    "BaseType": "sample string 8",
    "IsQbeFolder": "sample string 9",
    "BaseFolderName": "sample string 10",
    "IsPublic": true,
    "IsShared": true,
    "IsGlobal": true,
    "Owner": "sample string 14",
    "IsDefault": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfFavoriteFolderInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Model.Worklists">
  <FavoriteFolderInfo>
    <BaseFolderName>sample string 10</BaseFolderName>
    <BaseType>sample string 8</BaseType>
    <Count>sample string 6</Count>
    <FolderId>2</FolderId>
    <FolderUuid>sample string 3</FolderUuid>
    <Identifier>sample string 1</Identifier>
    <IsDefault>true</IsDefault>
    <IsGlobal>true</IsGlobal>
    <IsPublic>true</IsPublic>
    <IsQbeFolder>sample string 9</IsQbeFolder>
    <IsShared>true</IsShared>
    <IsStatCount>sample string 7</IsStatCount>
    <Label>sample string 4</Label>
    <Owner>sample string 14</Owner>
    <SortOrder>sample string 5</SortOrder>
    <WorklistType>Legacy</WorklistType>
  </FavoriteFolderInfo>
  <FavoriteFolderInfo>
    <BaseFolderName>sample string 10</BaseFolderName>
    <BaseType>sample string 8</BaseType>
    <Count>sample string 6</Count>
    <FolderId>2</FolderId>
    <FolderUuid>sample string 3</FolderUuid>
    <Identifier>sample string 1</Identifier>
    <IsDefault>true</IsDefault>
    <IsGlobal>true</IsGlobal>
    <IsPublic>true</IsPublic>
    <IsQbeFolder>sample string 9</IsQbeFolder>
    <IsShared>true</IsShared>
    <IsStatCount>sample string 7</IsStatCount>
    <Label>sample string 4</Label>
    <Owner>sample string 14</Owner>
    <SortOrder>sample string 5</SortOrder>
    <WorklistType>Legacy</WorklistType>
  </FavoriteFolderInfo>
</ArrayOfFavoriteFolderInfo>